@aws-sdk/client-kendra 3.300.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.
- package/README.md +40 -0
- package/dist-cjs/Kendra.js +75 -0
- package/dist-cjs/commands/BatchDeleteFeaturedResultsSetCommand.js +45 -0
- package/dist-cjs/commands/CreateFeaturedResultsSetCommand.js +45 -0
- package/dist-cjs/commands/DescribeFeaturedResultsSetCommand.js +45 -0
- package/dist-cjs/commands/ListFeaturedResultsSetsCommand.js +45 -0
- package/dist-cjs/commands/UpdateFeaturedResultsSetCommand.js +45 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +381 -438
- package/dist-cjs/models/models_1.js +20 -0
- package/dist-cjs/protocols/Aws_json1_1.js +597 -4
- package/dist-es/Kendra.js +75 -0
- package/dist-es/commands/BatchDeleteFeaturedResultsSetCommand.js +41 -0
- package/dist-es/commands/CreateFeaturedResultsSetCommand.js +41 -0
- package/dist-es/commands/DescribeFeaturedResultsSetCommand.js +41 -0
- package/dist-es/commands/ListFeaturedResultsSetsCommand.js +41 -0
- package/dist-es/commands/UpdateFeaturedResultsSetCommand.js +41 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +377 -434
- package/dist-es/models/models_1.js +18 -1
- package/dist-es/protocols/Aws_json1_1.js +584 -1
- package/dist-types/Kendra.d.ts +163 -132
- package/dist-types/KendraClient.d.ts +7 -2
- package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +4 -4
- package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +4 -4
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +9 -9
- package/dist-types/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +88 -0
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +16 -20
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +32 -31
- package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +2 -2
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +22 -25
- package/dist-types/commands/CreateDataSourceCommand.d.ts +171 -342
- package/dist-types/commands/CreateExperienceCommand.d.ts +9 -8
- package/dist-types/commands/CreateFaqCommand.d.ts +10 -10
- package/dist-types/commands/CreateFeaturedResultsSetCommand.d.ts +117 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +12 -11
- package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +7 -6
- package/dist-types/commands/CreateThesaurusCommand.d.ts +7 -6
- package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +6 -6
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteExperienceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteFaqCommand.d.ts +2 -2
- package/dist-types/commands/DeleteIndexCommand.d.ts +2 -2
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +14 -16
- package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/DeleteThesaurusCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +2 -2
- package/dist-types/commands/DescribeExperienceCommand.d.ts +2 -2
- package/dist-types/commands/DescribeFaqCommand.d.ts +2 -2
- package/dist-types/commands/DescribeFeaturedResultsSetCommand.d.ts +86 -0
- package/dist-types/commands/DescribeIndexCommand.d.ts +2 -2
- package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +9 -10
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +2 -2
- package/dist-types/commands/DescribeThesaurusCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +4 -4
- package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +3 -3
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +4 -3
- package/dist-types/commands/GetSnapshotsCommand.d.ts +4 -5
- package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +6 -6
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +3 -3
- package/dist-types/commands/ListDataSourcesCommand.d.ts +2 -2
- package/dist-types/commands/ListEntityPersonasCommand.d.ts +2 -2
- package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +2 -2
- package/dist-types/commands/ListExperiencesCommand.d.ts +2 -2
- package/dist-types/commands/ListFaqsCommand.d.ts +2 -2
- package/dist-types/commands/ListFeaturedResultsSetsCommand.d.ts +87 -0
- package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +5 -6
- package/dist-types/commands/ListIndicesCommand.d.ts +2 -2
- package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
- package/dist-types/commands/ListThesauriCommand.d.ts +2 -2
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +22 -28
- package/dist-types/commands/QueryCommand.d.ts +91 -215
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +3 -3
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +3 -3
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +7 -7
- package/dist-types/commands/TagResourceCommand.d.ts +7 -8
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +25 -25
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +168 -338
- package/dist-types/commands/UpdateExperienceCommand.d.ts +8 -8
- package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +105 -0
- package/dist-types/commands/UpdateIndexCommand.d.ts +16 -15
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +4 -4
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +2 -2
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +3 -3
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1943 -1687
- package/dist-types/models/models_1.d.ts +491 -72
- package/dist-types/protocols/Aws_json1_1.d.ts +15 -0
- package/dist-types/ts3.4/Kendra.d.ts +85 -0
- package/dist-types/ts3.4/KendraClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/CreateFeaturedResultsSetCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeFeaturedResultsSetCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListFeaturedResultsSetsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SubmitFeedbackCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccessControlConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateExperienceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFeaturedResultsSetCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +563 -453
- package/dist-types/ts3.4/models/models_1.d.ts +127 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
- package/package.json +34 -34
|
@@ -29,7 +29,7 @@ export interface DescribeExperienceCommandOutput extends DescribeExperienceRespo
|
|
|
29
29
|
* import { KendraClient, DescribeExperienceCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
30
30
|
* // const { KendraClient, DescribeExperienceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
31
31
|
* const client = new KendraClient(config);
|
|
32
|
-
* const input = {
|
|
32
|
+
* const input = { // DescribeExperienceRequest
|
|
33
33
|
* Id: "STRING_VALUE", // required
|
|
34
34
|
* IndexId: "STRING_VALUE", // required
|
|
35
35
|
* };
|
|
@@ -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/
|
|
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
|
|
@@ -26,7 +26,7 @@ export interface DescribeFaqCommandOutput extends DescribeFaqResponse, __Metadat
|
|
|
26
26
|
* import { KendraClient, DescribeFaqCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
27
27
|
* // const { KendraClient, DescribeFaqCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
28
28
|
* const client = new KendraClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // DescribeFaqRequest
|
|
30
30
|
* Id: "STRING_VALUE", // required
|
|
31
31
|
* IndexId: "STRING_VALUE", // required
|
|
32
32
|
* };
|
|
@@ -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/
|
|
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
|
+
}
|
|
@@ -26,7 +26,7 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met
|
|
|
26
26
|
* import { KendraClient, DescribeIndexCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
27
27
|
* // const { KendraClient, DescribeIndexCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
28
28
|
* const client = new KendraClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // DescribeIndexRequest
|
|
30
30
|
* Id: "STRING_VALUE", // required
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeIndexCommand(input);
|
|
@@ -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/
|
|
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,22 +19,21 @@ 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
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
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
|
|
34
33
|
* import { KendraClient, DescribePrincipalMappingCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
35
34
|
* // const { KendraClient, DescribePrincipalMappingCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
36
35
|
* const client = new KendraClient(config);
|
|
37
|
-
* const input = {
|
|
36
|
+
* const input = { // DescribePrincipalMappingRequest
|
|
38
37
|
* IndexId: "STRING_VALUE", // required
|
|
39
38
|
* DataSourceId: "STRING_VALUE",
|
|
40
39
|
* GroupId: "STRING_VALUE", // required
|
|
@@ -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/
|
|
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
|
|
@@ -32,7 +32,7 @@ export interface DescribeQuerySuggestionsBlockListCommandOutput extends Describe
|
|
|
32
32
|
* import { KendraClient, DescribeQuerySuggestionsBlockListCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
33
33
|
* // const { KendraClient, DescribeQuerySuggestionsBlockListCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
34
34
|
* const client = new KendraClient(config);
|
|
35
|
-
* const input = {
|
|
35
|
+
* const input = { // DescribeQuerySuggestionsBlockListRequest
|
|
36
36
|
* IndexId: "STRING_VALUE", // required
|
|
37
37
|
* Id: "STRING_VALUE", // required
|
|
38
38
|
* };
|
|
@@ -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/
|
|
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
|
|
@@ -31,7 +31,7 @@ export interface DescribeQuerySuggestionsConfigCommandOutput extends DescribeQue
|
|
|
31
31
|
* import { KendraClient, DescribeQuerySuggestionsConfigCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
32
32
|
* // const { KendraClient, DescribeQuerySuggestionsConfigCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
33
33
|
* const client = new KendraClient(config);
|
|
34
|
-
* const input = {
|
|
34
|
+
* const input = { // DescribeQuerySuggestionsConfigRequest
|
|
35
35
|
* IndexId: "STRING_VALUE", // required
|
|
36
36
|
* };
|
|
37
37
|
* const command = new DescribeQuerySuggestionsConfigCommand(input);
|
|
@@ -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/
|
|
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
|
|
@@ -26,7 +26,7 @@ export interface DescribeThesaurusCommandOutput extends DescribeThesaurusRespons
|
|
|
26
26
|
* import { KendraClient, DescribeThesaurusCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
27
27
|
* // const { KendraClient, DescribeThesaurusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
28
28
|
* const client = new KendraClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // DescribeThesaurusRequest
|
|
30
30
|
* Id: "STRING_VALUE", // required
|
|
31
31
|
* IndexId: "STRING_VALUE", // required
|
|
32
32
|
* };
|
|
@@ -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/
|
|
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
|
|
@@ -30,11 +30,11 @@ export interface DisassociateEntitiesFromExperienceCommandOutput extends Disasso
|
|
|
30
30
|
* import { KendraClient, DisassociateEntitiesFromExperienceCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
31
31
|
* // const { KendraClient, DisassociateEntitiesFromExperienceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
32
32
|
* const client = new KendraClient(config);
|
|
33
|
-
* const input = {
|
|
33
|
+
* const input = { // DisassociateEntitiesFromExperienceRequest
|
|
34
34
|
* Id: "STRING_VALUE", // required
|
|
35
35
|
* IndexId: "STRING_VALUE", // required
|
|
36
|
-
* EntityList: [ // required
|
|
37
|
-
* {
|
|
36
|
+
* EntityList: [ // DisassociateEntityList // required
|
|
37
|
+
* { // EntityConfiguration
|
|
38
38
|
* EntityId: "STRING_VALUE", // required
|
|
39
39
|
* EntityType: "USER" || "GROUP", // required
|
|
40
40
|
* },
|
|
@@ -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/
|
|
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
|
|
@@ -30,10 +30,10 @@ export interface DisassociatePersonasFromEntitiesCommandOutput extends Disassoci
|
|
|
30
30
|
* import { KendraClient, DisassociatePersonasFromEntitiesCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
31
31
|
* // const { KendraClient, DisassociatePersonasFromEntitiesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
32
32
|
* const client = new KendraClient(config);
|
|
33
|
-
* const input = {
|
|
33
|
+
* const input = { // DisassociatePersonasFromEntitiesRequest
|
|
34
34
|
* Id: "STRING_VALUE", // required
|
|
35
35
|
* IndexId: "STRING_VALUE", // required
|
|
36
|
-
* EntityIds: [ // required
|
|
36
|
+
* EntityIds: [ // EntityIdsList // required
|
|
37
37
|
* "STRING_VALUE",
|
|
38
38
|
* ],
|
|
39
39
|
* };
|
|
@@ -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/
|
|
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
|
|
@@ -29,7 +29,7 @@ export interface GetQuerySuggestionsCommandOutput extends GetQuerySuggestionsRes
|
|
|
29
29
|
* import { KendraClient, GetQuerySuggestionsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
30
30
|
* // const { KendraClient, GetQuerySuggestionsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
31
31
|
* const client = new KendraClient(config);
|
|
32
|
-
* const input = {
|
|
32
|
+
* const input = { // GetQuerySuggestionsRequest
|
|
33
33
|
* IndexId: "STRING_VALUE", // required
|
|
34
34
|
* QueryText: "STRING_VALUE", // required
|
|
35
35
|
* MaxSuggestionsCount: Number("int"),
|
|
@@ -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/
|
|
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
|
-
*
|
|
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,16 +19,15 @@ 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
|
-
*
|
|
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
|
|
28
27
|
* import { KendraClient, GetSnapshotsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
29
28
|
* // const { KendraClient, GetSnapshotsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
30
29
|
* const client = new KendraClient(config);
|
|
31
|
-
* const input = {
|
|
30
|
+
* const input = { // GetSnapshotsRequest
|
|
32
31
|
* IndexId: "STRING_VALUE", // required
|
|
33
32
|
* Interval: "THIS_MONTH" || "THIS_WEEK" || "ONE_WEEK_AGO" || "TWO_WEEKS_AGO" || "ONE_MONTH_AGO" || "TWO_MONTHS_AGO", // required
|
|
34
33
|
* MetricType: "QUERIES_BY_COUNT" || "QUERIES_BY_ZERO_CLICK_RATE" || "QUERIES_BY_ZERO_RESULT_RATE" || "DOCS_BY_CLICK_COUNT" || "AGG_QUERY_DOC_METRICS" || "TREND_QUERY_DOC_METRICS", // required
|
|
@@ -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/
|
|
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,17 +19,17 @@ 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
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
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
|
|
29
29
|
* import { KendraClient, ListAccessControlConfigurationsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
30
30
|
* // const { KendraClient, ListAccessControlConfigurationsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
31
31
|
* const client = new KendraClient(config);
|
|
32
|
-
* const input = {
|
|
32
|
+
* const input = { // ListAccessControlConfigurationsRequest
|
|
33
33
|
* IndexId: "STRING_VALUE", // required
|
|
34
34
|
* NextToken: "STRING_VALUE",
|
|
35
35
|
* MaxResults: Number("int"),
|
|
@@ -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/
|
|
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
|
|
@@ -26,12 +26,12 @@ export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJ
|
|
|
26
26
|
* import { KendraClient, ListDataSourceSyncJobsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
27
27
|
* // const { KendraClient, ListDataSourceSyncJobsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
28
28
|
* const client = new KendraClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // ListDataSourceSyncJobsRequest
|
|
30
30
|
* Id: "STRING_VALUE", // required
|
|
31
31
|
* IndexId: "STRING_VALUE", // required
|
|
32
32
|
* NextToken: "STRING_VALUE",
|
|
33
33
|
* MaxResults: Number("int"),
|
|
34
|
-
* StartTimeFilter: {
|
|
34
|
+
* StartTimeFilter: { // TimeRange
|
|
35
35
|
* StartTime: new Date("TIMESTAMP"),
|
|
36
36
|
* EndTime: new Date("TIMESTAMP"),
|
|
37
37
|
* },
|
|
@@ -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/
|
|
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
|
|
@@ -26,7 +26,7 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
|
|
|
26
26
|
* import { KendraClient, ListDataSourcesCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
27
27
|
* // const { KendraClient, ListDataSourcesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
28
28
|
* const client = new KendraClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // ListDataSourcesRequest
|
|
30
30
|
* IndexId: "STRING_VALUE", // required
|
|
31
31
|
* NextToken: "STRING_VALUE",
|
|
32
32
|
* MaxResults: Number("int"),
|
|
@@ -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/
|
|
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
|
|
@@ -27,7 +27,7 @@ export interface ListEntityPersonasCommandOutput extends ListEntityPersonasRespo
|
|
|
27
27
|
* import { KendraClient, ListEntityPersonasCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
28
28
|
* // const { KendraClient, ListEntityPersonasCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
29
29
|
* const client = new KendraClient(config);
|
|
30
|
-
* const input = {
|
|
30
|
+
* const input = { // ListEntityPersonasRequest
|
|
31
31
|
* Id: "STRING_VALUE", // required
|
|
32
32
|
* IndexId: "STRING_VALUE", // required
|
|
33
33
|
* NextToken: "STRING_VALUE",
|
|
@@ -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/
|
|
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
|
|
@@ -30,7 +30,7 @@ export interface ListExperienceEntitiesCommandOutput extends ListExperienceEntit
|
|
|
30
30
|
* import { KendraClient, ListExperienceEntitiesCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
31
31
|
* // const { KendraClient, ListExperienceEntitiesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
32
32
|
* const client = new KendraClient(config);
|
|
33
|
-
* const input = {
|
|
33
|
+
* const input = { // ListExperienceEntitiesRequest
|
|
34
34
|
* Id: "STRING_VALUE", // required
|
|
35
35
|
* IndexId: "STRING_VALUE", // required
|
|
36
36
|
* NextToken: "STRING_VALUE",
|
|
@@ -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/
|
|
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
|
|
@@ -29,7 +29,7 @@ export interface ListExperiencesCommandOutput extends ListExperiencesResponse, _
|
|
|
29
29
|
* import { KendraClient, ListExperiencesCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
30
30
|
* // const { KendraClient, ListExperiencesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
31
31
|
* const client = new KendraClient(config);
|
|
32
|
-
* const input = {
|
|
32
|
+
* const input = { // ListExperiencesRequest
|
|
33
33
|
* IndexId: "STRING_VALUE", // required
|
|
34
34
|
* NextToken: "STRING_VALUE",
|
|
35
35
|
* MaxResults: Number("int"),
|
|
@@ -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/
|
|
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
|
|
@@ -26,7 +26,7 @@ export interface ListFaqsCommandOutput extends ListFaqsResponse, __MetadataBeare
|
|
|
26
26
|
* import { KendraClient, ListFaqsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
27
27
|
* // const { KendraClient, ListFaqsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
28
28
|
* const client = new KendraClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // ListFaqsRequest
|
|
30
30
|
* IndexId: "STRING_VALUE", // required
|
|
31
31
|
* NextToken: "STRING_VALUE",
|
|
32
32
|
* MaxResults: Number("int"),
|
|
@@ -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/
|
|
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,18 +19,17 @@ 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
|
-
*
|
|
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
|
|
30
29
|
* import { KendraClient, ListGroupsOlderThanOrderingIdCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
31
30
|
* // const { KendraClient, ListGroupsOlderThanOrderingIdCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
32
31
|
* const client = new KendraClient(config);
|
|
33
|
-
* const input = {
|
|
32
|
+
* const input = { // ListGroupsOlderThanOrderingIdRequest
|
|
34
33
|
* IndexId: "STRING_VALUE", // required
|
|
35
34
|
* DataSourceId: "STRING_VALUE",
|
|
36
35
|
* OrderingId: Number("long"), // required
|
|
@@ -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/
|
|
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
|