@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,21 +19,19 @@ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Deletes a group so that all users and sub groups that belong to the group can
23
- * no longer access documents only available to that group.</p>
24
- * <p>For example, after deleting the group "Summer Interns", all interns who
25
- * belonged to that group no longer see intern-only documents in their search
26
- * results.</p>
27
- * <p>If you want to delete or replace users or sub groups of a group, you need to
28
- * use the <code>PutPrincipalMapping</code> operation. For example, if a user in
29
- * the group "Engineering" leaves the engineering team and another user takes
30
- * their place, you provide an updated list of users or sub groups that belong
31
- * to the "Engineering" group when calling <code>PutPrincipalMapping</code>. You
32
- * can update your internal list of users or sub groups and input this list
33
- * when calling <code>PutPrincipalMapping</code>.</p>
22
+ * <p>Deletes a group so that all users and sub groups that belong to the group can no
23
+ * longer access documents only available to that group.</p>
24
+ * <p>For example, after deleting the group "Summer Interns", all interns who belonged to
25
+ * that group no longer see intern-only documents in their search results.</p>
26
+ * <p>If you want to delete or replace users or sub groups of a group, you need to use the
27
+ * <code>PutPrincipalMapping</code> operation. For example, if a user in the group
28
+ * "Engineering" leaves the engineering team and another user takes their place, you
29
+ * provide an updated list of users or sub groups that belong to the "Engineering" group
30
+ * when calling <code>PutPrincipalMapping</code>. You can update your internal list of
31
+ * users or sub groups and input this list when calling
32
+ * <code>PutPrincipalMapping</code>.</p>
34
33
  * <p>
35
- * <code>DeletePrincipalMapping</code> is currently not supported in the
36
- * Amazon Web Services GovCloud (US-West) region.</p>
34
+ * <code>DeletePrincipalMapping</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
37
35
  * @example
38
36
  * Use a bare-bones client and the command you need to make an API call.
39
37
  * ```javascript
@@ -66,7 +64,7 @@ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {
66
64
  *
67
65
  * @throws {@link InternalServerException} (server fault)
68
66
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
69
- * 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>
67
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
70
68
  *
71
69
  * @throws {@link ResourceNotFoundException} (client fault)
72
70
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -56,7 +56,7 @@ export interface DeleteQuerySuggestionsBlockListCommandOutput extends __Metadata
56
56
  *
57
57
  * @throws {@link InternalServerException} (server fault)
58
58
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
59
- * 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>
59
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
60
60
  *
61
61
  * @throws {@link ResourceNotFoundException} (client fault)
62
62
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -51,7 +51,7 @@ export interface DeleteThesaurusCommandOutput extends __MetadataBearer {
51
51
  *
52
52
  * @throws {@link InternalServerException} (server fault)
53
53
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
54
- * 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>
54
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
55
55
  *
56
56
  * @throws {@link ResourceNotFoundException} (client fault)
57
57
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -21,8 +21,8 @@ export interface DescribeAccessControlConfigurationCommandOutput extends Describ
21
21
  * @public
22
22
  * <p>Gets information about an access control configuration that you created for your
23
23
  * documents in an index. This includes user and group access information for your
24
- * documents. This is useful for user context filtering, where search results are
25
- * filtered based on the user or their group access to documents.</p>
24
+ * documents. This is useful for user context filtering, where search results are filtered
25
+ * based on the user or their group access to documents.</p>
26
26
  * @example
27
27
  * Use a bare-bones client and the command you need to make an API call.
28
28
  * ```javascript
@@ -49,7 +49,7 @@ export interface DescribeAccessControlConfigurationCommandOutput extends Describ
49
49
  *
50
50
  * @throws {@link InternalServerException} (server fault)
51
51
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
52
- * 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>
52
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
53
53
  *
54
54
  * @throws {@link ResourceNotFoundException} (client fault)
55
55
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -46,7 +46,7 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
46
46
  *
47
47
  * @throws {@link InternalServerException} (server fault)
48
48
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
49
- * 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>
49
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
50
50
  *
51
51
  * @throws {@link ResourceNotFoundException} (client fault)
52
52
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -49,7 +49,7 @@ export interface DescribeExperienceCommandOutput extends DescribeExperienceRespo
49
49
  *
50
50
  * @throws {@link InternalServerException} (server fault)
51
51
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
52
- * 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>
52
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
53
53
  *
54
54
  * @throws {@link ResourceNotFoundException} (client fault)
55
55
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -46,7 +46,7 @@ export interface DescribeFaqCommandOutput extends DescribeFaqResponse, __Metadat
46
46
  *
47
47
  * @throws {@link InternalServerException} (server fault)
48
48
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
49
- * 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>
49
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
50
50
  *
51
51
  * @throws {@link ResourceNotFoundException} (client fault)
52
52
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -0,0 +1,86 @@
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 { DescribeFeaturedResultsSetRequest, DescribeFeaturedResultsSetResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link DescribeFeaturedResultsSetCommand}.
10
+ */
11
+ export interface DescribeFeaturedResultsSetCommandInput extends DescribeFeaturedResultsSetRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link DescribeFeaturedResultsSetCommand}.
17
+ */
18
+ export interface DescribeFeaturedResultsSetCommandOutput extends DescribeFeaturedResultsSetResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Gets information about a set of featured results. Features results are placed
23
+ * above all other results for certain queries. If there's an exact match of a query,
24
+ * then one or more specific documents are featured in the search results.</p>
25
+ * @example
26
+ * Use a bare-bones client and the command you need to make an API call.
27
+ * ```javascript
28
+ * import { KendraClient, DescribeFeaturedResultsSetCommand } from "@aws-sdk/client-kendra"; // ES Modules import
29
+ * // const { KendraClient, DescribeFeaturedResultsSetCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
30
+ * const client = new KendraClient(config);
31
+ * const input = { // DescribeFeaturedResultsSetRequest
32
+ * IndexId: "STRING_VALUE", // required
33
+ * FeaturedResultsSetId: "STRING_VALUE", // required
34
+ * };
35
+ * const command = new DescribeFeaturedResultsSetCommand(input);
36
+ * const response = await client.send(command);
37
+ * ```
38
+ *
39
+ * @param DescribeFeaturedResultsSetCommandInput - {@link DescribeFeaturedResultsSetCommandInput}
40
+ * @returns {@link DescribeFeaturedResultsSetCommandOutput}
41
+ * @see {@link DescribeFeaturedResultsSetCommandInput} for command's `input` shape.
42
+ * @see {@link DescribeFeaturedResultsSetCommandOutput} for command's `response` shape.
43
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
44
+ *
45
+ * @throws {@link AccessDeniedException} (client fault)
46
+ * <p>You don't have sufficient access to perform this action. Please ensure you have the
47
+ * required permission policies and user accounts and try again.</p>
48
+ *
49
+ * @throws {@link InternalServerException} (server fault)
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/contact-us/">Support</a> for help.</p>
52
+ *
53
+ * @throws {@link ResourceNotFoundException} (client fault)
54
+ * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
55
+ * resource and try again.</p>
56
+ *
57
+ * @throws {@link ThrottlingException} (client fault)
58
+ * <p>The request was denied due to request throttling. Please reduce the number of requests
59
+ * and try again.</p>
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
63
+ * Please provide the correct input and try again.</p>
64
+ *
65
+ *
66
+ */
67
+ export declare class DescribeFeaturedResultsSetCommand extends $Command<DescribeFeaturedResultsSetCommandInput, DescribeFeaturedResultsSetCommandOutput, KendraClientResolvedConfig> {
68
+ readonly input: DescribeFeaturedResultsSetCommandInput;
69
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
73
+ constructor(input: DescribeFeaturedResultsSetCommandInput);
74
+ /**
75
+ * @internal
76
+ */
77
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeFeaturedResultsSetCommandInput, DescribeFeaturedResultsSetCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
81
+ private serialize;
82
+ /**
83
+ * @internal
84
+ */
85
+ private deserialize;
86
+ }
@@ -45,7 +45,7 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met
45
45
  *
46
46
  * @throws {@link InternalServerException} (server fault)
47
47
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
48
- * 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>
48
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
49
49
  *
50
50
  * @throws {@link ResourceNotFoundException} (client fault)
51
51
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -19,15 +19,14 @@ export interface DescribePrincipalMappingCommandOutput extends DescribePrincipal
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Describes the processing of <code>PUT</code> and <code>DELETE</code> actions
23
- * for mapping users to their groups. This includes information on the status of
24
- * actions currently processing or yet to be processed, when actions were last updated,
25
- * when actions were received by Amazon Kendra, the latest action that should process
26
- * and apply after other actions, and useful error messages if an action could
27
- * not be processed.</p>
22
+ * <p>Describes the processing of <code>PUT</code> and <code>DELETE</code> actions for
23
+ * mapping users to their groups. This includes information on the status of actions
24
+ * currently processing or yet to be processed, when actions were last updated, when
25
+ * actions were received by Amazon Kendra, the latest action that should process and
26
+ * apply after other actions, and useful error messages if an action could not be
27
+ * processed.</p>
28
28
  * <p>
29
- * <code>DescribePrincipalMapping</code> is currently not supported in the
30
- * Amazon Web Services GovCloud (US-West) region.</p>
29
+ * <code>DescribePrincipalMapping</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
31
30
  * @example
32
31
  * Use a bare-bones client and the command you need to make an API call.
33
32
  * ```javascript
@@ -55,7 +54,7 @@ export interface DescribePrincipalMappingCommandOutput extends DescribePrincipal
55
54
  *
56
55
  * @throws {@link InternalServerException} (server fault)
57
56
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
58
- * 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>
57
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
59
58
  *
60
59
  * @throws {@link ResourceNotFoundException} (client fault)
61
60
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -52,7 +52,7 @@ export interface DescribeQuerySuggestionsBlockListCommandOutput extends Describe
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 ResourceNotFoundException} (client fault)
58
58
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -50,7 +50,7 @@ export interface DescribeQuerySuggestionsConfigCommandOutput extends DescribeQue
50
50
  *
51
51
  * @throws {@link InternalServerException} (server fault)
52
52
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
53
- * 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>
53
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
54
54
  *
55
55
  * @throws {@link ResourceNotFoundException} (client fault)
56
56
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -46,7 +46,7 @@ export interface DescribeThesaurusCommandOutput extends DescribeThesaurusRespons
46
46
  *
47
47
  * @throws {@link InternalServerException} (server fault)
48
48
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
49
- * 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>
49
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
50
50
  *
51
51
  * @throws {@link ResourceNotFoundException} (client fault)
52
52
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -56,7 +56,7 @@ export interface DisassociateEntitiesFromExperienceCommandOutput extends Disasso
56
56
  *
57
57
  * @throws {@link InternalServerException} (server fault)
58
58
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
59
- * 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>
59
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
60
60
  *
61
61
  * @throws {@link ResourceNotFoundException} (client fault)
62
62
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -53,7 +53,7 @@ export interface DisassociatePersonasFromEntitiesCommandOutput extends Disassoci
53
53
  *
54
54
  * @throws {@link InternalServerException} (server fault)
55
55
  * <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>
56
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
57
57
  *
58
58
  * @throws {@link ResourceNotFoundException} (client fault)
59
59
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -54,7 +54,7 @@ export interface GetQuerySuggestionsCommandOutput extends GetQuerySuggestionsRes
54
54
  *
55
55
  * @throws {@link InternalServerException} (server fault)
56
56
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
57
- * 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>
57
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
58
58
  *
59
59
  * @throws {@link ResourceNotFoundException} (client fault)
60
60
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -62,7 +62,8 @@ export interface GetQuerySuggestionsCommandOutput extends GetQuerySuggestionsRes
62
62
  *
63
63
  * @throws {@link ServiceQuotaExceededException} (client fault)
64
64
  * <p>You have exceeded the set limits for your Amazon Kendra service. Please see
65
- * 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
65
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
66
+ * more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
66
67
  * an increase of limits.</p>
67
68
  *
68
69
  * @throws {@link ThrottlingException} (client fault)
@@ -19,9 +19,8 @@ export interface GetSnapshotsCommandOutput extends GetSnapshotsResponse, __Metad
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Retrieves search metrics data. The data provides a snapshot of how
23
- * your users interact with your search application and how effective
24
- * the application is.</p>
22
+ * <p>Retrieves search metrics data. The data provides a snapshot of how your users interact
23
+ * with your search application and how effective the application is.</p>
25
24
  * @example
26
25
  * Use a bare-bones client and the command you need to make an API call.
27
26
  * ```javascript
@@ -51,7 +50,7 @@ export interface GetSnapshotsCommandOutput extends GetSnapshotsResponse, __Metad
51
50
  *
52
51
  * @throws {@link InternalServerException} (server fault)
53
52
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
54
- * 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>
53
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
55
54
  *
56
55
  * @throws {@link InvalidRequestException} (client fault)
57
56
  * <p>The input to the request is not valid. Please provide the correct input and try
@@ -19,10 +19,10 @@ export interface ListAccessControlConfigurationsCommandOutput extends ListAccess
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Lists one or more access control configurations for an index. This
23
- * includes user and group access information for your documents. This
24
- * is useful for user context filtering, where search results are filtered
25
- * based on the user or their group access to documents.</p>
22
+ * <p>Lists one or more access control configurations for an index. This includes user and
23
+ * group access information for your documents. This is useful for user context filtering,
24
+ * where search results are filtered based on the user or their group access to
25
+ * documents.</p>
26
26
  * @example
27
27
  * Use a bare-bones client and the command you need to make an API call.
28
28
  * ```javascript
@@ -50,7 +50,7 @@ export interface ListAccessControlConfigurationsCommandOutput extends ListAccess
50
50
  *
51
51
  * @throws {@link InternalServerException} (server fault)
52
52
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
53
- * 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>
53
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
54
54
  *
55
55
  * @throws {@link ResourceNotFoundException} (client fault)
56
56
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -57,7 +57,7 @@ export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJ
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
@@ -47,7 +47,7 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
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
@@ -49,7 +49,7 @@ export interface ListEntityPersonasCommandOutput extends ListEntityPersonasRespo
49
49
  *
50
50
  * @throws {@link InternalServerException} (server fault)
51
51
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
52
- * 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>
52
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
53
53
  *
54
54
  * @throws {@link ResourceNotFoundException} (client fault)
55
55
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -51,7 +51,7 @@ export interface ListExperienceEntitiesCommandOutput extends ListExperienceEntit
51
51
  *
52
52
  * @throws {@link InternalServerException} (server fault)
53
53
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
54
- * 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>
54
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
55
55
  *
56
56
  * @throws {@link ResourceNotFoundException} (client fault)
57
57
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -50,7 +50,7 @@ export interface ListExperiencesCommandOutput extends ListExperiencesResponse, _
50
50
  *
51
51
  * @throws {@link InternalServerException} (server fault)
52
52
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
53
- * 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>
53
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
54
54
  *
55
55
  * @throws {@link ResourceNotFoundException} (client fault)
56
56
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -47,7 +47,7 @@ export interface ListFaqsCommandOutput extends ListFaqsResponse, __MetadataBeare
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
@@ -0,0 +1,87 @@
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 { ListFeaturedResultsSetsRequest, ListFeaturedResultsSetsResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link ListFeaturedResultsSetsCommand}.
10
+ */
11
+ export interface ListFeaturedResultsSetsCommandInput extends ListFeaturedResultsSetsRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link ListFeaturedResultsSetsCommand}.
17
+ */
18
+ export interface ListFeaturedResultsSetsCommandOutput extends ListFeaturedResultsSetsResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Lists all your sets of featured results for a given index. Features results
23
+ * are placed above all other results for certain queries. If there's an exact match
24
+ * of a query, then one or more specific documents are featured in the search results.</p>
25
+ * @example
26
+ * Use a bare-bones client and the command you need to make an API call.
27
+ * ```javascript
28
+ * import { KendraClient, ListFeaturedResultsSetsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
29
+ * // const { KendraClient, ListFeaturedResultsSetsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
30
+ * const client = new KendraClient(config);
31
+ * const input = { // ListFeaturedResultsSetsRequest
32
+ * IndexId: "STRING_VALUE", // required
33
+ * NextToken: "STRING_VALUE",
34
+ * MaxResults: Number("int"),
35
+ * };
36
+ * const command = new ListFeaturedResultsSetsCommand(input);
37
+ * const response = await client.send(command);
38
+ * ```
39
+ *
40
+ * @param ListFeaturedResultsSetsCommandInput - {@link ListFeaturedResultsSetsCommandInput}
41
+ * @returns {@link ListFeaturedResultsSetsCommandOutput}
42
+ * @see {@link ListFeaturedResultsSetsCommandInput} for command's `input` shape.
43
+ * @see {@link ListFeaturedResultsSetsCommandOutput} for command's `response` shape.
44
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
45
+ *
46
+ * @throws {@link AccessDeniedException} (client fault)
47
+ * <p>You don't have sufficient access to perform this action. Please ensure you have the
48
+ * required permission policies and user accounts and try again.</p>
49
+ *
50
+ * @throws {@link InternalServerException} (server fault)
51
+ * <p>An issue occurred with the internal server used for your Amazon Kendra service.
52
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
53
+ *
54
+ * @throws {@link ResourceNotFoundException} (client fault)
55
+ * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
56
+ * resource and try again.</p>
57
+ *
58
+ * @throws {@link ThrottlingException} (client fault)
59
+ * <p>The request was denied due to request throttling. Please reduce the number of requests
60
+ * and try again.</p>
61
+ *
62
+ * @throws {@link ValidationException} (client fault)
63
+ * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
64
+ * Please provide the correct input and try again.</p>
65
+ *
66
+ *
67
+ */
68
+ export declare class ListFeaturedResultsSetsCommand extends $Command<ListFeaturedResultsSetsCommandInput, ListFeaturedResultsSetsCommandOutput, KendraClientResolvedConfig> {
69
+ readonly input: ListFeaturedResultsSetsCommandInput;
70
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
74
+ constructor(input: ListFeaturedResultsSetsCommandInput);
75
+ /**
76
+ * @internal
77
+ */
78
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListFeaturedResultsSetsCommandInput, ListFeaturedResultsSetsCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
82
+ private serialize;
83
+ /**
84
+ * @internal
85
+ */
86
+ private deserialize;
87
+ }
@@ -19,11 +19,10 @@ export interface ListGroupsOlderThanOrderingIdCommandOutput extends ListGroupsOl
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Provides a list of groups that are mapped to users before a
23
- * given ordering or timestamp identifier.</p>
22
+ * <p>Provides a list of groups that are mapped to users before a given ordering or
23
+ * timestamp identifier.</p>
24
24
  * <p>
25
- * <code>ListGroupsOlderThanOrderingId</code> is currently not supported in the
26
- * Amazon Web Services GovCloud (US-West) region.</p>
25
+ * <code>ListGroupsOlderThanOrderingId</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
27
26
  * @example
28
27
  * Use a bare-bones client and the command you need to make an API call.
29
28
  * ```javascript
@@ -57,7 +56,7 @@ export interface ListGroupsOlderThanOrderingIdCommandOutput extends ListGroupsOl
57
56
  *
58
57
  * @throws {@link InternalServerException} (server fault)
59
58
  * <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>
59
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
61
60
  *
62
61
  * @throws {@link ResourceNotFoundException} (client fault)
63
62
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -46,7 +46,7 @@ export interface ListIndicesCommandOutput extends ListIndicesResponse, __Metadat
46
46
  *
47
47
  * @throws {@link InternalServerException} (server fault)
48
48
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
49
- * 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>
49
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
50
50
  *
51
51
  * @throws {@link ThrottlingException} (client fault)
52
52
  * <p>The request was denied due to request throttling. Please reduce the number of requests
@@ -53,7 +53,7 @@ export interface ListQuerySuggestionsBlockListsCommandOutput extends ListQuerySu
53
53
  *
54
54
  * @throws {@link InternalServerException} (server fault)
55
55
  * <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>
56
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
57
57
  *
58
58
  * @throws {@link ResourceNotFoundException} (client fault)
59
59
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -19,8 +19,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Gets a list of tags associated with a specified resource. Indexes,
23
- * FAQs, and data sources can have tags associated with them.</p>
22
+ * <p>Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources
23
+ * can have tags associated with them.</p>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
26
26
  * ```javascript
@@ -46,7 +46,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
46
46
  *
47
47
  * @throws {@link InternalServerException} (server fault)
48
48
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
49
- * 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>
49
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
50
50
  *
51
51
  * @throws {@link ResourceUnavailableException} (client fault)
52
52
  * <p>The resource you want to use isn't available. Please check you have provided the
@@ -47,7 +47,7 @@ export interface ListThesauriCommandOutput extends ListThesauriResponse, __Metad
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