@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.
- 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 +1 -1
- package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +6 -6
- package/dist-types/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +88 -0
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +9 -13
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +14 -13
- package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +17 -20
- package/dist-types/commands/CreateDataSourceCommand.d.ts +3 -4
- package/dist-types/commands/CreateExperienceCommand.d.ts +3 -2
- package/dist-types/commands/CreateFaqCommand.d.ts +6 -6
- package/dist-types/commands/CreateFeaturedResultsSetCommand.d.ts +117 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +3 -2
- package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +3 -2
- package/dist-types/commands/CreateThesaurusCommand.d.ts +3 -2
- package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFaqCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +13 -15
- package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFaqCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFeaturedResultsSetCommand.d.ts +86 -0
- package/dist-types/commands/DescribeIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +8 -9
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +3 -2
- package/dist-types/commands/GetSnapshotsCommand.d.ts +3 -4
- package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +5 -5
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListEntityPersonasCommand.d.ts +1 -1
- package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/ListExperiencesCommand.d.ts +1 -1
- package/dist-types/commands/ListFaqsCommand.d.ts +1 -1
- package/dist-types/commands/ListFeaturedResultsSetsCommand.d.ts +87 -0
- package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +4 -5
- package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
- package/dist-types/commands/ListThesauriCommand.d.ts +1 -1
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +15 -21
- package/dist-types/commands/QueryCommand.d.ts +3 -2
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +2 -2
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +2 -2
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +4 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +20 -20
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateExperienceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +105 -0
- package/dist-types/commands/UpdateIndexCommand.d.ts +4 -3
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
- 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
package/dist-types/Kendra.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
|
2
2
|
import { AssociateEntitiesToExperienceCommandInput, AssociateEntitiesToExperienceCommandOutput } from "./commands/AssociateEntitiesToExperienceCommand";
|
|
3
3
|
import { AssociatePersonasToEntitiesCommandInput, AssociatePersonasToEntitiesCommandOutput } from "./commands/AssociatePersonasToEntitiesCommand";
|
|
4
4
|
import { BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput } from "./commands/BatchDeleteDocumentCommand";
|
|
5
|
+
import { BatchDeleteFeaturedResultsSetCommandInput, BatchDeleteFeaturedResultsSetCommandOutput } from "./commands/BatchDeleteFeaturedResultsSetCommand";
|
|
5
6
|
import { BatchGetDocumentStatusCommandInput, BatchGetDocumentStatusCommandOutput } from "./commands/BatchGetDocumentStatusCommand";
|
|
6
7
|
import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./commands/BatchPutDocumentCommand";
|
|
7
8
|
import { ClearQuerySuggestionsCommandInput, ClearQuerySuggestionsCommandOutput } from "./commands/ClearQuerySuggestionsCommand";
|
|
@@ -9,6 +10,7 @@ import { CreateAccessControlConfigurationCommandInput, CreateAccessControlConfig
|
|
|
9
10
|
import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand";
|
|
10
11
|
import { CreateExperienceCommandInput, CreateExperienceCommandOutput } from "./commands/CreateExperienceCommand";
|
|
11
12
|
import { CreateFaqCommandInput, CreateFaqCommandOutput } from "./commands/CreateFaqCommand";
|
|
13
|
+
import { CreateFeaturedResultsSetCommandInput, CreateFeaturedResultsSetCommandOutput } from "./commands/CreateFeaturedResultsSetCommand";
|
|
12
14
|
import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
|
|
13
15
|
import { CreateQuerySuggestionsBlockListCommandInput, CreateQuerySuggestionsBlockListCommandOutput } from "./commands/CreateQuerySuggestionsBlockListCommand";
|
|
14
16
|
import { CreateThesaurusCommandInput, CreateThesaurusCommandOutput } from "./commands/CreateThesaurusCommand";
|
|
@@ -24,6 +26,7 @@ import { DescribeAccessControlConfigurationCommandInput, DescribeAccessControlCo
|
|
|
24
26
|
import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "./commands/DescribeDataSourceCommand";
|
|
25
27
|
import { DescribeExperienceCommandInput, DescribeExperienceCommandOutput } from "./commands/DescribeExperienceCommand";
|
|
26
28
|
import { DescribeFaqCommandInput, DescribeFaqCommandOutput } from "./commands/DescribeFaqCommand";
|
|
29
|
+
import { DescribeFeaturedResultsSetCommandInput, DescribeFeaturedResultsSetCommandOutput } from "./commands/DescribeFeaturedResultsSetCommand";
|
|
27
30
|
import { DescribeIndexCommandInput, DescribeIndexCommandOutput } from "./commands/DescribeIndexCommand";
|
|
28
31
|
import { DescribePrincipalMappingCommandInput, DescribePrincipalMappingCommandOutput } from "./commands/DescribePrincipalMappingCommand";
|
|
29
32
|
import { DescribeQuerySuggestionsBlockListCommandInput, DescribeQuerySuggestionsBlockListCommandOutput } from "./commands/DescribeQuerySuggestionsBlockListCommand";
|
|
@@ -40,6 +43,7 @@ import { ListEntityPersonasCommandInput, ListEntityPersonasCommandOutput } from
|
|
|
40
43
|
import { ListExperienceEntitiesCommandInput, ListExperienceEntitiesCommandOutput } from "./commands/ListExperienceEntitiesCommand";
|
|
41
44
|
import { ListExperiencesCommandInput, ListExperiencesCommandOutput } from "./commands/ListExperiencesCommand";
|
|
42
45
|
import { ListFaqsCommandInput, ListFaqsCommandOutput } from "./commands/ListFaqsCommand";
|
|
46
|
+
import { ListFeaturedResultsSetsCommandInput, ListFeaturedResultsSetsCommandOutput } from "./commands/ListFeaturedResultsSetsCommand";
|
|
43
47
|
import { ListGroupsOlderThanOrderingIdCommandInput, ListGroupsOlderThanOrderingIdCommandOutput } from "./commands/ListGroupsOlderThanOrderingIdCommand";
|
|
44
48
|
import { ListIndicesCommandInput, ListIndicesCommandOutput } from "./commands/ListIndicesCommand";
|
|
45
49
|
import { ListQuerySuggestionsBlockListsCommandInput, ListQuerySuggestionsBlockListsCommandOutput } from "./commands/ListQuerySuggestionsBlockListsCommand";
|
|
@@ -55,6 +59,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
55
59
|
import { UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput } from "./commands/UpdateAccessControlConfigurationCommand";
|
|
56
60
|
import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "./commands/UpdateDataSourceCommand";
|
|
57
61
|
import { UpdateExperienceCommandInput, UpdateExperienceCommandOutput } from "./commands/UpdateExperienceCommand";
|
|
62
|
+
import { UpdateFeaturedResultsSetCommandInput, UpdateFeaturedResultsSetCommandOutput } from "./commands/UpdateFeaturedResultsSetCommand";
|
|
58
63
|
import { UpdateIndexCommandInput, UpdateIndexCommandOutput } from "./commands/UpdateIndexCommand";
|
|
59
64
|
import { UpdateQuerySuggestionsBlockListCommandInput, UpdateQuerySuggestionsBlockListCommandOutput } from "./commands/UpdateQuerySuggestionsBlockListCommand";
|
|
60
65
|
import { UpdateQuerySuggestionsConfigCommandInput, UpdateQuerySuggestionsConfigCommandOutput } from "./commands/UpdateQuerySuggestionsConfigCommand";
|
|
@@ -89,30 +94,35 @@ export declare class Kendra extends KendraClient {
|
|
|
89
94
|
associatePersonasToEntities(args: AssociatePersonasToEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePersonasToEntitiesCommandOutput) => void): void;
|
|
90
95
|
/**
|
|
91
96
|
* @public
|
|
92
|
-
* <p>Removes one or more documents from an index. The documents must have
|
|
93
|
-
*
|
|
94
|
-
* <p>The documents are deleted asynchronously. You can see the progress of
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
+
* <p>Removes one or more documents from an index. The documents must have been added with
|
|
98
|
+
* the <code>BatchPutDocument</code> API.</p>
|
|
99
|
+
* <p>The documents are deleted asynchronously. You can see the progress of the deletion by
|
|
100
|
+
* using Amazon Web Services CloudWatch. Any error messages related to the processing of the
|
|
101
|
+
* batch are sent to you CloudWatch log.</p>
|
|
97
102
|
*/
|
|
98
103
|
batchDeleteDocument(args: BatchDeleteDocumentCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteDocumentCommandOutput>;
|
|
99
104
|
batchDeleteDocument(args: BatchDeleteDocumentCommandInput, cb: (err: any, data?: BatchDeleteDocumentCommandOutput) => void): void;
|
|
100
105
|
batchDeleteDocument(args: BatchDeleteDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDocumentCommandOutput) => void): void;
|
|
101
106
|
/**
|
|
102
107
|
* @public
|
|
103
|
-
* <p>
|
|
104
|
-
*
|
|
108
|
+
* <p>Removes one or more sets of featured results. Features results are placed
|
|
109
|
+
* above all other results for certain queries. If there's an exact match of a
|
|
110
|
+
* query, then one or more specific documents are featured in the search results.</p>
|
|
111
|
+
*/
|
|
112
|
+
batchDeleteFeaturedResultsSet(args: BatchDeleteFeaturedResultsSetCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteFeaturedResultsSetCommandOutput>;
|
|
113
|
+
batchDeleteFeaturedResultsSet(args: BatchDeleteFeaturedResultsSetCommandInput, cb: (err: any, data?: BatchDeleteFeaturedResultsSetCommandOutput) => void): void;
|
|
114
|
+
batchDeleteFeaturedResultsSet(args: BatchDeleteFeaturedResultsSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteFeaturedResultsSetCommandOutput) => void): void;
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
* <p>Returns the indexing status for one or more documents submitted with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
|
|
105
118
|
* BatchPutDocument</a> API.</p>
|
|
106
|
-
* <p>When you use the <code>BatchPutDocument</code> API,
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
* BatchDeleteDocument</a> API. When a document is
|
|
114
|
-
* deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the
|
|
115
|
-
* status.</p>
|
|
119
|
+
* <p>When you use the <code>BatchPutDocument</code> API, documents are indexed
|
|
120
|
+
* asynchronously. You can use the <code>BatchGetDocumentStatus</code> API to get the
|
|
121
|
+
* current status of a list of documents so that you can determine if they have been
|
|
122
|
+
* successfully indexed.</p>
|
|
123
|
+
* <p>You can also use the <code>BatchGetDocumentStatus</code> API to check the status of
|
|
124
|
+
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html">
|
|
125
|
+
* BatchDeleteDocument</a> API. When a document is deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the status.</p>
|
|
116
126
|
*/
|
|
117
127
|
batchGetDocumentStatus(args: BatchGetDocumentStatusCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetDocumentStatusCommandOutput>;
|
|
118
128
|
batchGetDocumentStatus(args: BatchGetDocumentStatusCommandInput, cb: (err: any, data?: BatchGetDocumentStatusCommandOutput) => void): void;
|
|
@@ -120,17 +130,17 @@ export declare class Kendra extends KendraClient {
|
|
|
120
130
|
/**
|
|
121
131
|
* @public
|
|
122
132
|
* <p>Adds one or more documents to an index.</p>
|
|
123
|
-
* <p>The <code>BatchPutDocument</code> API enables you to ingest
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
133
|
+
* <p>The <code>BatchPutDocument</code> API enables you to ingest inline documents or a set
|
|
134
|
+
* of documents stored in an Amazon S3 bucket. Use this API to ingest your text and
|
|
135
|
+
* unstructured text into an index, add custom attributes to the documents, and to attach
|
|
136
|
+
* an access control list to the documents added to the index.</p>
|
|
137
|
+
* <p>The documents are indexed asynchronously. You can see the progress of the batch using
|
|
138
|
+
* Amazon Web Services
|
|
139
|
+
* CloudWatch. Any error messages related to processing the batch are sent to your
|
|
140
|
+
* Amazon Web Services
|
|
141
|
+
* CloudWatch log.</p>
|
|
142
|
+
* <p>For an example of ingesting inline documents using Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding files
|
|
143
|
+
* directly to an index</a>.</p>
|
|
134
144
|
*/
|
|
135
145
|
batchPutDocument(args: BatchPutDocumentCommandInput, options?: __HttpHandlerOptions): Promise<BatchPutDocumentCommandOutput>;
|
|
136
146
|
batchPutDocument(args: BatchPutDocumentCommandInput, cb: (err: any, data?: BatchPutDocumentCommandOutput) => void): void;
|
|
@@ -153,29 +163,25 @@ export declare class Kendra extends KendraClient {
|
|
|
153
163
|
clearQuerySuggestions(args: ClearQuerySuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClearQuerySuggestionsCommandOutput) => void): void;
|
|
154
164
|
/**
|
|
155
165
|
* @public
|
|
156
|
-
* <p>Creates an access configuration for your documents. This includes
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
* on the user or their group access to documents.</p>
|
|
166
|
+
* <p>Creates an access configuration for your documents. This includes user and group
|
|
167
|
+
* access information for your documents. This is useful for user context filtering, where
|
|
168
|
+
* search results are filtered based on the user or their group access to documents.</p>
|
|
160
169
|
* <p>You can use this to re-configure your existing document level access control without
|
|
161
170
|
* indexing all of your documents again. For example, your index contains top-secret
|
|
162
171
|
* company documents that only certain employees or users should access. One of these users
|
|
163
172
|
* leaves the company or switches to a team that should be blocked from accessing
|
|
164
173
|
* top-secret documents. The user still has access to top-secret documents because the user
|
|
165
|
-
* had access when your documents were previously indexed. You
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
* <p>To apply your access control configuration to certain documents, you call
|
|
171
|
-
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
* and synchronize your data source. Amazon Kendra currently only supports
|
|
177
|
-
* access control configuration for S3 data sources and documents indexed using the
|
|
178
|
-
* <code>BatchPutDocument</code> API.</p>
|
|
174
|
+
* had access when your documents were previously indexed. You can create a specific access
|
|
175
|
+
* control configuration for the user with deny access. You can later update the access
|
|
176
|
+
* control configuration to allow access if the user returns to the company and re-joins
|
|
177
|
+
* the 'top-secret' team. You can re-configure access control for your documents as
|
|
178
|
+
* circumstances change.</p>
|
|
179
|
+
* <p>To apply your access control configuration to certain documents, you call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API with the <code>AccessControlConfigurationId</code>
|
|
180
|
+
* included in the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a> object. If you use an S3 bucket as a data source, you update the
|
|
181
|
+
* <code>.metadata.json</code> with the <code>AccessControlConfigurationId</code> and
|
|
182
|
+
* synchronize your data source. Amazon Kendra currently only supports access control
|
|
183
|
+
* configuration for S3 data sources and documents indexed using the
|
|
184
|
+
* <code>BatchPutDocument</code> API.</p>
|
|
179
185
|
*/
|
|
180
186
|
createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessControlConfigurationCommandOutput>;
|
|
181
187
|
createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
|
|
@@ -189,8 +195,6 @@ export declare class Kendra extends KendraClient {
|
|
|
189
195
|
* <p>
|
|
190
196
|
* <code>CreateDataSource</code> is a synchronous operation. The operation returns 200 if the
|
|
191
197
|
* data source was successfully created. Otherwise, an exception is raised.</p>
|
|
192
|
-
* <p>Amazon S3 and <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html">custom</a> data sources are the only
|
|
193
|
-
* supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
|
|
194
198
|
* <p>For an example of creating an index and data source using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting started with Python
|
|
195
199
|
* SDK</a>. For an example of creating an index and data source using the Java SDK, see
|
|
196
200
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java
|
|
@@ -211,15 +215,27 @@ export declare class Kendra extends KendraClient {
|
|
|
211
215
|
createExperience(args: CreateExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExperienceCommandOutput) => void): void;
|
|
212
216
|
/**
|
|
213
217
|
* @public
|
|
214
|
-
* <p>Creates
|
|
218
|
+
* <p>Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored
|
|
219
|
+
* in an Amazon S3 bucket.</p>
|
|
215
220
|
* <p>Adding FAQs to an index is an asynchronous operation.</p>
|
|
216
|
-
* <p>For an example of adding an FAQ to an index using Python and Java SDKs,
|
|
217
|
-
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your
|
|
218
|
-
* FAQ file</a>.</p>
|
|
221
|
+
* <p>For an example of adding an FAQ to an index using Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your FAQ file</a>.</p>
|
|
219
222
|
*/
|
|
220
223
|
createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): Promise<CreateFaqCommandOutput>;
|
|
221
224
|
createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
|
|
222
225
|
createFaq(args: CreateFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
|
|
226
|
+
/**
|
|
227
|
+
* @public
|
|
228
|
+
* <p>Creates a set of featured results to display at the top of the search results page.
|
|
229
|
+
* Featured results are placed above all other results for certain queries. You map
|
|
230
|
+
* specific queries to specific documents for featuring in the results. If a query
|
|
231
|
+
* contains an exact match, then one or more specific documents are featured in the
|
|
232
|
+
* search results.</p>
|
|
233
|
+
* <p>You can create up to 50 sets of featured results per index. You can request to
|
|
234
|
+
* increase this limit by contacting <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
235
|
+
*/
|
|
236
|
+
createFeaturedResultsSet(args: CreateFeaturedResultsSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateFeaturedResultsSetCommandOutput>;
|
|
237
|
+
createFeaturedResultsSet(args: CreateFeaturedResultsSetCommandInput, cb: (err: any, data?: CreateFeaturedResultsSetCommandOutput) => void): void;
|
|
238
|
+
createFeaturedResultsSet(args: CreateFeaturedResultsSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFeaturedResultsSetCommandOutput) => void): void;
|
|
223
239
|
/**
|
|
224
240
|
* @public
|
|
225
241
|
* <p>Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine
|
|
@@ -270,10 +286,10 @@ export declare class Kendra extends KendraClient {
|
|
|
270
286
|
createThesaurus(args: CreateThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void;
|
|
271
287
|
/**
|
|
272
288
|
* @public
|
|
273
|
-
* <p>Deletes an access control configuration that you created for your
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
*
|
|
289
|
+
* <p>Deletes an access control configuration that you created for your documents in an
|
|
290
|
+
* index. This includes user and group access information for your documents. This is
|
|
291
|
+
* useful for user context filtering, where search results are filtered based on the user
|
|
292
|
+
* or their group access to documents.</p>
|
|
277
293
|
*/
|
|
278
294
|
deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessControlConfigurationCommandOutput>;
|
|
279
295
|
deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void): void;
|
|
@@ -316,21 +332,19 @@ export declare class Kendra extends KendraClient {
|
|
|
316
332
|
deleteIndex(args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
|
|
317
333
|
/**
|
|
318
334
|
* @public
|
|
319
|
-
* <p>Deletes a group so that all users and sub groups that belong to the group can
|
|
320
|
-
*
|
|
321
|
-
* <p>For example, after deleting the group "Summer Interns", all interns who
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
* when calling <code>PutPrincipalMapping</code>.</p>
|
|
335
|
+
* <p>Deletes a group so that all users and sub groups that belong to the group can no
|
|
336
|
+
* longer access documents only available to that group.</p>
|
|
337
|
+
* <p>For example, after deleting the group "Summer Interns", all interns who belonged to
|
|
338
|
+
* that group no longer see intern-only documents in their search results.</p>
|
|
339
|
+
* <p>If you want to delete or replace users or sub groups of a group, you need to use the
|
|
340
|
+
* <code>PutPrincipalMapping</code> operation. For example, if a user in the group
|
|
341
|
+
* "Engineering" leaves the engineering team and another user takes their place, you
|
|
342
|
+
* provide an updated list of users or sub groups that belong to the "Engineering" group
|
|
343
|
+
* when calling <code>PutPrincipalMapping</code>. You can update your internal list of
|
|
344
|
+
* users or sub groups and input this list when calling
|
|
345
|
+
* <code>PutPrincipalMapping</code>.</p>
|
|
331
346
|
* <p>
|
|
332
|
-
* <code>DeletePrincipalMapping</code> is currently not supported in the
|
|
333
|
-
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
347
|
+
* <code>DeletePrincipalMapping</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
|
|
334
348
|
*/
|
|
335
349
|
deletePrincipalMapping(args: DeletePrincipalMappingCommandInput, options?: __HttpHandlerOptions): Promise<DeletePrincipalMappingCommandOutput>;
|
|
336
350
|
deletePrincipalMapping(args: DeletePrincipalMappingCommandInput, cb: (err: any, data?: DeletePrincipalMappingCommandOutput) => void): void;
|
|
@@ -360,8 +374,8 @@ export declare class Kendra extends KendraClient {
|
|
|
360
374
|
* @public
|
|
361
375
|
* <p>Gets information about an access control configuration that you created for your
|
|
362
376
|
* documents in an index. This includes user and group access information for your
|
|
363
|
-
* documents. This is useful for user context filtering, where search results are
|
|
364
|
-
*
|
|
377
|
+
* documents. This is useful for user context filtering, where search results are filtered
|
|
378
|
+
* based on the user or their group access to documents.</p>
|
|
365
379
|
*/
|
|
366
380
|
describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccessControlConfigurationCommandOutput>;
|
|
367
381
|
describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void): void;
|
|
@@ -390,6 +404,15 @@ export declare class Kendra extends KendraClient {
|
|
|
390
404
|
describeFaq(args: DescribeFaqCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFaqCommandOutput>;
|
|
391
405
|
describeFaq(args: DescribeFaqCommandInput, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void;
|
|
392
406
|
describeFaq(args: DescribeFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void;
|
|
407
|
+
/**
|
|
408
|
+
* @public
|
|
409
|
+
* <p>Gets information about a set of featured results. Features results are placed
|
|
410
|
+
* above all other results for certain queries. If there's an exact match of a query,
|
|
411
|
+
* then one or more specific documents are featured in the search results.</p>
|
|
412
|
+
*/
|
|
413
|
+
describeFeaturedResultsSet(args: DescribeFeaturedResultsSetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFeaturedResultsSetCommandOutput>;
|
|
414
|
+
describeFeaturedResultsSet(args: DescribeFeaturedResultsSetCommandInput, cb: (err: any, data?: DescribeFeaturedResultsSetCommandOutput) => void): void;
|
|
415
|
+
describeFeaturedResultsSet(args: DescribeFeaturedResultsSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeaturedResultsSetCommandOutput) => void): void;
|
|
393
416
|
/**
|
|
394
417
|
* @public
|
|
395
418
|
* <p>Gets information about an existing Amazon Kendra index.</p>
|
|
@@ -399,15 +422,14 @@ export declare class Kendra extends KendraClient {
|
|
|
399
422
|
describeIndex(args: DescribeIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIndexCommandOutput) => void): void;
|
|
400
423
|
/**
|
|
401
424
|
* @public
|
|
402
|
-
* <p>Describes the processing of <code>PUT</code> and <code>DELETE</code> actions
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
*
|
|
425
|
+
* <p>Describes the processing of <code>PUT</code> and <code>DELETE</code> actions for
|
|
426
|
+
* mapping users to their groups. This includes information on the status of actions
|
|
427
|
+
* currently processing or yet to be processed, when actions were last updated, when
|
|
428
|
+
* actions were received by Amazon Kendra, the latest action that should process and
|
|
429
|
+
* apply after other actions, and useful error messages if an action could not be
|
|
430
|
+
* processed.</p>
|
|
408
431
|
* <p>
|
|
409
|
-
* <code>DescribePrincipalMapping</code> is currently not supported in the
|
|
410
|
-
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
432
|
+
* <code>DescribePrincipalMapping</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
|
|
411
433
|
*/
|
|
412
434
|
describePrincipalMapping(args: DescribePrincipalMappingCommandInput, options?: __HttpHandlerOptions): Promise<DescribePrincipalMappingCommandOutput>;
|
|
413
435
|
describePrincipalMapping(args: DescribePrincipalMappingCommandInput, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void): void;
|
|
@@ -478,19 +500,18 @@ export declare class Kendra extends KendraClient {
|
|
|
478
500
|
getQuerySuggestions(args: GetQuerySuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQuerySuggestionsCommandOutput) => void): void;
|
|
479
501
|
/**
|
|
480
502
|
* @public
|
|
481
|
-
* <p>Retrieves search metrics data. The data provides a snapshot of how
|
|
482
|
-
*
|
|
483
|
-
* the application is.</p>
|
|
503
|
+
* <p>Retrieves search metrics data. The data provides a snapshot of how your users interact
|
|
504
|
+
* with your search application and how effective the application is.</p>
|
|
484
505
|
*/
|
|
485
506
|
getSnapshots(args: GetSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<GetSnapshotsCommandOutput>;
|
|
486
507
|
getSnapshots(args: GetSnapshotsCommandInput, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void;
|
|
487
508
|
getSnapshots(args: GetSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void;
|
|
488
509
|
/**
|
|
489
510
|
* @public
|
|
490
|
-
* <p>Lists one or more access control configurations for an index. This
|
|
491
|
-
*
|
|
492
|
-
*
|
|
493
|
-
*
|
|
511
|
+
* <p>Lists one or more access control configurations for an index. This includes user and
|
|
512
|
+
* group access information for your documents. This is useful for user context filtering,
|
|
513
|
+
* where search results are filtered based on the user or their group access to
|
|
514
|
+
* documents.</p>
|
|
494
515
|
*/
|
|
495
516
|
listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessControlConfigurationsCommandOutput>;
|
|
496
517
|
listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void): void;
|
|
@@ -547,11 +568,19 @@ export declare class Kendra extends KendraClient {
|
|
|
547
568
|
listFaqs(args: ListFaqsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFaqsCommandOutput) => void): void;
|
|
548
569
|
/**
|
|
549
570
|
* @public
|
|
550
|
-
* <p>
|
|
551
|
-
*
|
|
571
|
+
* <p>Lists all your sets of featured results for a given index. Features results
|
|
572
|
+
* are placed above all other results for certain queries. If there's an exact match
|
|
573
|
+
* of a query, then one or more specific documents are featured in the search results.</p>
|
|
574
|
+
*/
|
|
575
|
+
listFeaturedResultsSets(args: ListFeaturedResultsSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListFeaturedResultsSetsCommandOutput>;
|
|
576
|
+
listFeaturedResultsSets(args: ListFeaturedResultsSetsCommandInput, cb: (err: any, data?: ListFeaturedResultsSetsCommandOutput) => void): void;
|
|
577
|
+
listFeaturedResultsSets(args: ListFeaturedResultsSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFeaturedResultsSetsCommandOutput) => void): void;
|
|
578
|
+
/**
|
|
579
|
+
* @public
|
|
580
|
+
* <p>Provides a list of groups that are mapped to users before a given ordering or
|
|
581
|
+
* timestamp identifier.</p>
|
|
552
582
|
* <p>
|
|
553
|
-
* <code>ListGroupsOlderThanOrderingId</code> is currently not supported in the
|
|
554
|
-
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
583
|
+
* <code>ListGroupsOlderThanOrderingId</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
|
|
555
584
|
*/
|
|
556
585
|
listGroupsOlderThanOrderingId(args: ListGroupsOlderThanOrderingIdCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsOlderThanOrderingIdCommandOutput>;
|
|
557
586
|
listGroupsOlderThanOrderingId(args: ListGroupsOlderThanOrderingIdCommandInput, cb: (err: any, data?: ListGroupsOlderThanOrderingIdCommandOutput) => void): void;
|
|
@@ -578,8 +607,8 @@ export declare class Kendra extends KendraClient {
|
|
|
578
607
|
listQuerySuggestionsBlockLists(args: ListQuerySuggestionsBlockListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQuerySuggestionsBlockListsCommandOutput) => void): void;
|
|
579
608
|
/**
|
|
580
609
|
* @public
|
|
581
|
-
* <p>Gets a list of tags associated with a specified resource. Indexes,
|
|
582
|
-
*
|
|
610
|
+
* <p>Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources
|
|
611
|
+
* can have tags associated with them.</p>
|
|
583
612
|
*/
|
|
584
613
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
585
614
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
@@ -593,25 +622,18 @@ export declare class Kendra extends KendraClient {
|
|
|
593
622
|
listThesauri(args: ListThesauriCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThesauriCommandOutput) => void): void;
|
|
594
623
|
/**
|
|
595
624
|
* @public
|
|
596
|
-
* <p>Maps users to their groups so that you only need to provide
|
|
597
|
-
* the
|
|
598
|
-
* <p>You can also map sub groups to groups.
|
|
599
|
-
*
|
|
600
|
-
*
|
|
601
|
-
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
*
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
*
|
|
608
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering
|
|
609
|
-
* on user context</a>.</p>
|
|
610
|
-
* <p>If more than five <code>PUT</code> actions for a group are currently
|
|
611
|
-
* processing, a validation exception is thrown.</p>
|
|
612
|
-
* <p>
|
|
613
|
-
* <code>PutPrincipalMapping</code> is currently not supported in the
|
|
614
|
-
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
625
|
+
* <p>Maps users to their groups so that you only need to provide the user ID when you issue
|
|
626
|
+
* the query.</p>
|
|
627
|
+
* <p>You can also map sub groups to groups. For example, the group "Company Intellectual
|
|
628
|
+
* Property Teams" includes sub groups "Research" and "Engineering". These sub groups
|
|
629
|
+
* include their own list of users or people who work in these teams. Only users who work
|
|
630
|
+
* in research and engineering, and therefore belong in the intellectual property group,
|
|
631
|
+
* can see top-secret company documents in their search results.</p>
|
|
632
|
+
* <p>This is useful for user context filtering, where search results are filtered based on
|
|
633
|
+
* the user or their group access to documents. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering on
|
|
634
|
+
* user context</a>.</p>
|
|
635
|
+
* <p>If more than five <code>PUT</code> actions for a group are currently processing, a
|
|
636
|
+
* validation exception is thrown.</p>
|
|
615
637
|
*/
|
|
616
638
|
putPrincipalMapping(args: PutPrincipalMappingCommandInput, options?: __HttpHandlerOptions): Promise<PutPrincipalMappingCommandOutput>;
|
|
617
639
|
putPrincipalMapping(args: PutPrincipalMappingCommandInput, cb: (err: any, data?: PutPrincipalMappingCommandOutput) => void): void;
|
|
@@ -673,9 +695,8 @@ export declare class Kendra extends KendraClient {
|
|
|
673
695
|
submitFeedback(args: SubmitFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitFeedbackCommandOutput) => void): void;
|
|
674
696
|
/**
|
|
675
697
|
* @public
|
|
676
|
-
* <p>Adds the specified tag to the specified index, FAQ, or data source
|
|
677
|
-
*
|
|
678
|
-
* the new value.</p>
|
|
698
|
+
* <p>Adds the specified tag to the specified index, FAQ, or data source resource. If the tag
|
|
699
|
+
* already exists, the existing value is replaced with the new value.</p>
|
|
679
700
|
*/
|
|
680
701
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
681
702
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
@@ -689,26 +710,25 @@ export declare class Kendra extends KendraClient {
|
|
|
689
710
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
690
711
|
/**
|
|
691
712
|
* @public
|
|
692
|
-
* <p>Updates an access control configuration for your documents in an index. This
|
|
693
|
-
*
|
|
694
|
-
*
|
|
695
|
-
*
|
|
696
|
-
* <p>You can update an access control configuration you created without indexing all
|
|
697
|
-
*
|
|
698
|
-
*
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
*
|
|
702
|
-
*
|
|
703
|
-
*
|
|
713
|
+
* <p>Updates an access control configuration for your documents in an index. This includes
|
|
714
|
+
* user and group access information for your documents. This is useful for user context
|
|
715
|
+
* filtering, where search results are filtered based on the user or their group access to
|
|
716
|
+
* documents.</p>
|
|
717
|
+
* <p>You can update an access control configuration you created without indexing all of
|
|
718
|
+
* your documents again. For example, your index contains top-secret company documents that
|
|
719
|
+
* only certain employees or users should access. You created an 'allow' access control
|
|
720
|
+
* configuration for one user who recently joined the 'top-secret' team, switching from a
|
|
721
|
+
* team with 'deny' access to top-secret documents. However, the user suddenly returns to
|
|
722
|
+
* their previous team and should no longer have access to top secret documents. You can
|
|
723
|
+
* update the access control configuration to re-configure access control for your
|
|
724
|
+
* documents as circumstances change.</p>
|
|
704
725
|
* <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to
|
|
705
726
|
* apply the updated access control configuration, with the
|
|
706
|
-
* <code>AccessControlConfigurationId</code> included in the
|
|
707
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
727
|
+
* <code>AccessControlConfigurationId</code> included in the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
708
728
|
* object. If you use an S3 bucket as a data source, you synchronize your data source to
|
|
709
|
-
* apply the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code>
|
|
710
|
-
* Amazon Kendra currently only supports access control configuration for S3
|
|
711
|
-
* sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
|
|
729
|
+
* apply the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code>
|
|
730
|
+
* file. Amazon Kendra currently only supports access control configuration for S3
|
|
731
|
+
* data sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
|
|
712
732
|
*/
|
|
713
733
|
updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccessControlConfigurationCommandOutput>;
|
|
714
734
|
updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void): void;
|
|
@@ -729,6 +749,17 @@ export declare class Kendra extends KendraClient {
|
|
|
729
749
|
updateExperience(args: UpdateExperienceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateExperienceCommandOutput>;
|
|
730
750
|
updateExperience(args: UpdateExperienceCommandInput, cb: (err: any, data?: UpdateExperienceCommandOutput) => void): void;
|
|
731
751
|
updateExperience(args: UpdateExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExperienceCommandOutput) => void): void;
|
|
752
|
+
/**
|
|
753
|
+
* @public
|
|
754
|
+
* <p>Updates a set of featured results. Features results are placed
|
|
755
|
+
* above
|
|
756
|
+
* all other results for certain queries. You map specific queries to specific documents
|
|
757
|
+
* for featuring in the results. If a query contains an exact match of a query, then one
|
|
758
|
+
* or more specific documents are featured in the search results.</p>
|
|
759
|
+
*/
|
|
760
|
+
updateFeaturedResultsSet(args: UpdateFeaturedResultsSetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFeaturedResultsSetCommandOutput>;
|
|
761
|
+
updateFeaturedResultsSet(args: UpdateFeaturedResultsSetCommandInput, cb: (err: any, data?: UpdateFeaturedResultsSetCommandOutput) => void): void;
|
|
762
|
+
updateFeaturedResultsSet(args: UpdateFeaturedResultsSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFeaturedResultsSetCommandOutput) => void): void;
|
|
732
763
|
/**
|
|
733
764
|
* @public
|
|
734
765
|
* <p>Updates an existing Amazon Kendra index.</p>
|
|
@@ -10,6 +10,7 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
|
|
|
10
10
|
import { AssociateEntitiesToExperienceCommandInput, AssociateEntitiesToExperienceCommandOutput } from "./commands/AssociateEntitiesToExperienceCommand";
|
|
11
11
|
import { AssociatePersonasToEntitiesCommandInput, AssociatePersonasToEntitiesCommandOutput } from "./commands/AssociatePersonasToEntitiesCommand";
|
|
12
12
|
import { BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput } from "./commands/BatchDeleteDocumentCommand";
|
|
13
|
+
import { BatchDeleteFeaturedResultsSetCommandInput, BatchDeleteFeaturedResultsSetCommandOutput } from "./commands/BatchDeleteFeaturedResultsSetCommand";
|
|
13
14
|
import { BatchGetDocumentStatusCommandInput, BatchGetDocumentStatusCommandOutput } from "./commands/BatchGetDocumentStatusCommand";
|
|
14
15
|
import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./commands/BatchPutDocumentCommand";
|
|
15
16
|
import { ClearQuerySuggestionsCommandInput, ClearQuerySuggestionsCommandOutput } from "./commands/ClearQuerySuggestionsCommand";
|
|
@@ -17,6 +18,7 @@ import { CreateAccessControlConfigurationCommandInput, CreateAccessControlConfig
|
|
|
17
18
|
import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand";
|
|
18
19
|
import { CreateExperienceCommandInput, CreateExperienceCommandOutput } from "./commands/CreateExperienceCommand";
|
|
19
20
|
import { CreateFaqCommandInput, CreateFaqCommandOutput } from "./commands/CreateFaqCommand";
|
|
21
|
+
import { CreateFeaturedResultsSetCommandInput, CreateFeaturedResultsSetCommandOutput } from "./commands/CreateFeaturedResultsSetCommand";
|
|
20
22
|
import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
|
|
21
23
|
import { CreateQuerySuggestionsBlockListCommandInput, CreateQuerySuggestionsBlockListCommandOutput } from "./commands/CreateQuerySuggestionsBlockListCommand";
|
|
22
24
|
import { CreateThesaurusCommandInput, CreateThesaurusCommandOutput } from "./commands/CreateThesaurusCommand";
|
|
@@ -32,6 +34,7 @@ import { DescribeAccessControlConfigurationCommandInput, DescribeAccessControlCo
|
|
|
32
34
|
import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "./commands/DescribeDataSourceCommand";
|
|
33
35
|
import { DescribeExperienceCommandInput, DescribeExperienceCommandOutput } from "./commands/DescribeExperienceCommand";
|
|
34
36
|
import { DescribeFaqCommandInput, DescribeFaqCommandOutput } from "./commands/DescribeFaqCommand";
|
|
37
|
+
import { DescribeFeaturedResultsSetCommandInput, DescribeFeaturedResultsSetCommandOutput } from "./commands/DescribeFeaturedResultsSetCommand";
|
|
35
38
|
import { DescribeIndexCommandInput, DescribeIndexCommandOutput } from "./commands/DescribeIndexCommand";
|
|
36
39
|
import { DescribePrincipalMappingCommandInput, DescribePrincipalMappingCommandOutput } from "./commands/DescribePrincipalMappingCommand";
|
|
37
40
|
import { DescribeQuerySuggestionsBlockListCommandInput, DescribeQuerySuggestionsBlockListCommandOutput } from "./commands/DescribeQuerySuggestionsBlockListCommand";
|
|
@@ -48,6 +51,7 @@ import { ListEntityPersonasCommandInput, ListEntityPersonasCommandOutput } from
|
|
|
48
51
|
import { ListExperienceEntitiesCommandInput, ListExperienceEntitiesCommandOutput } from "./commands/ListExperienceEntitiesCommand";
|
|
49
52
|
import { ListExperiencesCommandInput, ListExperiencesCommandOutput } from "./commands/ListExperiencesCommand";
|
|
50
53
|
import { ListFaqsCommandInput, ListFaqsCommandOutput } from "./commands/ListFaqsCommand";
|
|
54
|
+
import { ListFeaturedResultsSetsCommandInput, ListFeaturedResultsSetsCommandOutput } from "./commands/ListFeaturedResultsSetsCommand";
|
|
51
55
|
import { ListGroupsOlderThanOrderingIdCommandInput, ListGroupsOlderThanOrderingIdCommandOutput } from "./commands/ListGroupsOlderThanOrderingIdCommand";
|
|
52
56
|
import { ListIndicesCommandInput, ListIndicesCommandOutput } from "./commands/ListIndicesCommand";
|
|
53
57
|
import { ListQuerySuggestionsBlockListsCommandInput, ListQuerySuggestionsBlockListsCommandOutput } from "./commands/ListQuerySuggestionsBlockListsCommand";
|
|
@@ -63,6 +67,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
63
67
|
import { UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput } from "./commands/UpdateAccessControlConfigurationCommand";
|
|
64
68
|
import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "./commands/UpdateDataSourceCommand";
|
|
65
69
|
import { UpdateExperienceCommandInput, UpdateExperienceCommandOutput } from "./commands/UpdateExperienceCommand";
|
|
70
|
+
import { UpdateFeaturedResultsSetCommandInput, UpdateFeaturedResultsSetCommandOutput } from "./commands/UpdateFeaturedResultsSetCommand";
|
|
66
71
|
import { UpdateIndexCommandInput, UpdateIndexCommandOutput } from "./commands/UpdateIndexCommand";
|
|
67
72
|
import { UpdateQuerySuggestionsBlockListCommandInput, UpdateQuerySuggestionsBlockListCommandOutput } from "./commands/UpdateQuerySuggestionsBlockListCommand";
|
|
68
73
|
import { UpdateQuerySuggestionsConfigCommandInput, UpdateQuerySuggestionsConfigCommandOutput } from "./commands/UpdateQuerySuggestionsConfigCommand";
|
|
@@ -71,11 +76,11 @@ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, Endpoi
|
|
|
71
76
|
/**
|
|
72
77
|
* @public
|
|
73
78
|
*/
|
|
74
|
-
export type ServiceInputTypes = AssociateEntitiesToExperienceCommandInput | AssociatePersonasToEntitiesCommandInput | BatchDeleteDocumentCommandInput | BatchGetDocumentStatusCommandInput | BatchPutDocumentCommandInput | ClearQuerySuggestionsCommandInput | CreateAccessControlConfigurationCommandInput | CreateDataSourceCommandInput | CreateExperienceCommandInput | CreateFaqCommandInput | CreateIndexCommandInput | CreateQuerySuggestionsBlockListCommandInput | CreateThesaurusCommandInput | DeleteAccessControlConfigurationCommandInput | DeleteDataSourceCommandInput | DeleteExperienceCommandInput | DeleteFaqCommandInput | DeleteIndexCommandInput | DeletePrincipalMappingCommandInput | DeleteQuerySuggestionsBlockListCommandInput | DeleteThesaurusCommandInput | DescribeAccessControlConfigurationCommandInput | DescribeDataSourceCommandInput | DescribeExperienceCommandInput | DescribeFaqCommandInput | DescribeIndexCommandInput | DescribePrincipalMappingCommandInput | DescribeQuerySuggestionsBlockListCommandInput | DescribeQuerySuggestionsConfigCommandInput | DescribeThesaurusCommandInput | DisassociateEntitiesFromExperienceCommandInput | DisassociatePersonasFromEntitiesCommandInput | GetQuerySuggestionsCommandInput | GetSnapshotsCommandInput | ListAccessControlConfigurationsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListEntityPersonasCommandInput | ListExperienceEntitiesCommandInput | ListExperiencesCommandInput | ListFaqsCommandInput | ListGroupsOlderThanOrderingIdCommandInput | ListIndicesCommandInput | ListQuerySuggestionsBlockListsCommandInput | ListTagsForResourceCommandInput | ListThesauriCommandInput | PutPrincipalMappingCommandInput | QueryCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | SubmitFeedbackCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessControlConfigurationCommandInput | UpdateDataSourceCommandInput | UpdateExperienceCommandInput | UpdateIndexCommandInput | UpdateQuerySuggestionsBlockListCommandInput | UpdateQuerySuggestionsConfigCommandInput | UpdateThesaurusCommandInput;
|
|
79
|
+
export type ServiceInputTypes = AssociateEntitiesToExperienceCommandInput | AssociatePersonasToEntitiesCommandInput | BatchDeleteDocumentCommandInput | BatchDeleteFeaturedResultsSetCommandInput | BatchGetDocumentStatusCommandInput | BatchPutDocumentCommandInput | ClearQuerySuggestionsCommandInput | CreateAccessControlConfigurationCommandInput | CreateDataSourceCommandInput | CreateExperienceCommandInput | CreateFaqCommandInput | CreateFeaturedResultsSetCommandInput | CreateIndexCommandInput | CreateQuerySuggestionsBlockListCommandInput | CreateThesaurusCommandInput | DeleteAccessControlConfigurationCommandInput | DeleteDataSourceCommandInput | DeleteExperienceCommandInput | DeleteFaqCommandInput | DeleteIndexCommandInput | DeletePrincipalMappingCommandInput | DeleteQuerySuggestionsBlockListCommandInput | DeleteThesaurusCommandInput | DescribeAccessControlConfigurationCommandInput | DescribeDataSourceCommandInput | DescribeExperienceCommandInput | DescribeFaqCommandInput | DescribeFeaturedResultsSetCommandInput | DescribeIndexCommandInput | DescribePrincipalMappingCommandInput | DescribeQuerySuggestionsBlockListCommandInput | DescribeQuerySuggestionsConfigCommandInput | DescribeThesaurusCommandInput | DisassociateEntitiesFromExperienceCommandInput | DisassociatePersonasFromEntitiesCommandInput | GetQuerySuggestionsCommandInput | GetSnapshotsCommandInput | ListAccessControlConfigurationsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListEntityPersonasCommandInput | ListExperienceEntitiesCommandInput | ListExperiencesCommandInput | ListFaqsCommandInput | ListFeaturedResultsSetsCommandInput | ListGroupsOlderThanOrderingIdCommandInput | ListIndicesCommandInput | ListQuerySuggestionsBlockListsCommandInput | ListTagsForResourceCommandInput | ListThesauriCommandInput | PutPrincipalMappingCommandInput | QueryCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | SubmitFeedbackCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessControlConfigurationCommandInput | UpdateDataSourceCommandInput | UpdateExperienceCommandInput | UpdateFeaturedResultsSetCommandInput | UpdateIndexCommandInput | UpdateQuerySuggestionsBlockListCommandInput | UpdateQuerySuggestionsConfigCommandInput | UpdateThesaurusCommandInput;
|
|
75
80
|
/**
|
|
76
81
|
* @public
|
|
77
82
|
*/
|
|
78
|
-
export type ServiceOutputTypes = AssociateEntitiesToExperienceCommandOutput | AssociatePersonasToEntitiesCommandOutput | BatchDeleteDocumentCommandOutput | BatchGetDocumentStatusCommandOutput | BatchPutDocumentCommandOutput | ClearQuerySuggestionsCommandOutput | CreateAccessControlConfigurationCommandOutput | CreateDataSourceCommandOutput | CreateExperienceCommandOutput | CreateFaqCommandOutput | CreateIndexCommandOutput | CreateQuerySuggestionsBlockListCommandOutput | CreateThesaurusCommandOutput | DeleteAccessControlConfigurationCommandOutput | DeleteDataSourceCommandOutput | DeleteExperienceCommandOutput | DeleteFaqCommandOutput | DeleteIndexCommandOutput | DeletePrincipalMappingCommandOutput | DeleteQuerySuggestionsBlockListCommandOutput | DeleteThesaurusCommandOutput | DescribeAccessControlConfigurationCommandOutput | DescribeDataSourceCommandOutput | DescribeExperienceCommandOutput | DescribeFaqCommandOutput | DescribeIndexCommandOutput | DescribePrincipalMappingCommandOutput | DescribeQuerySuggestionsBlockListCommandOutput | DescribeQuerySuggestionsConfigCommandOutput | DescribeThesaurusCommandOutput | DisassociateEntitiesFromExperienceCommandOutput | DisassociatePersonasFromEntitiesCommandOutput | GetQuerySuggestionsCommandOutput | GetSnapshotsCommandOutput | ListAccessControlConfigurationsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListEntityPersonasCommandOutput | ListExperienceEntitiesCommandOutput | ListExperiencesCommandOutput | ListFaqsCommandOutput | ListGroupsOlderThanOrderingIdCommandOutput | ListIndicesCommandOutput | ListQuerySuggestionsBlockListsCommandOutput | ListTagsForResourceCommandOutput | ListThesauriCommandOutput | PutPrincipalMappingCommandOutput | QueryCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | SubmitFeedbackCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessControlConfigurationCommandOutput | UpdateDataSourceCommandOutput | UpdateExperienceCommandOutput | UpdateIndexCommandOutput | UpdateQuerySuggestionsBlockListCommandOutput | UpdateQuerySuggestionsConfigCommandOutput | UpdateThesaurusCommandOutput;
|
|
83
|
+
export type ServiceOutputTypes = AssociateEntitiesToExperienceCommandOutput | AssociatePersonasToEntitiesCommandOutput | BatchDeleteDocumentCommandOutput | BatchDeleteFeaturedResultsSetCommandOutput | BatchGetDocumentStatusCommandOutput | BatchPutDocumentCommandOutput | ClearQuerySuggestionsCommandOutput | CreateAccessControlConfigurationCommandOutput | CreateDataSourceCommandOutput | CreateExperienceCommandOutput | CreateFaqCommandOutput | CreateFeaturedResultsSetCommandOutput | CreateIndexCommandOutput | CreateQuerySuggestionsBlockListCommandOutput | CreateThesaurusCommandOutput | DeleteAccessControlConfigurationCommandOutput | DeleteDataSourceCommandOutput | DeleteExperienceCommandOutput | DeleteFaqCommandOutput | DeleteIndexCommandOutput | DeletePrincipalMappingCommandOutput | DeleteQuerySuggestionsBlockListCommandOutput | DeleteThesaurusCommandOutput | DescribeAccessControlConfigurationCommandOutput | DescribeDataSourceCommandOutput | DescribeExperienceCommandOutput | DescribeFaqCommandOutput | DescribeFeaturedResultsSetCommandOutput | DescribeIndexCommandOutput | DescribePrincipalMappingCommandOutput | DescribeQuerySuggestionsBlockListCommandOutput | DescribeQuerySuggestionsConfigCommandOutput | DescribeThesaurusCommandOutput | DisassociateEntitiesFromExperienceCommandOutput | DisassociatePersonasFromEntitiesCommandOutput | GetQuerySuggestionsCommandOutput | GetSnapshotsCommandOutput | ListAccessControlConfigurationsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListEntityPersonasCommandOutput | ListExperienceEntitiesCommandOutput | ListExperiencesCommandOutput | ListFaqsCommandOutput | ListFeaturedResultsSetsCommandOutput | ListGroupsOlderThanOrderingIdCommandOutput | ListIndicesCommandOutput | ListQuerySuggestionsBlockListsCommandOutput | ListTagsForResourceCommandOutput | ListThesauriCommandOutput | PutPrincipalMappingCommandOutput | QueryCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | SubmitFeedbackCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessControlConfigurationCommandOutput | UpdateDataSourceCommandOutput | UpdateExperienceCommandOutput | UpdateFeaturedResultsSetCommandOutput | UpdateIndexCommandOutput | UpdateQuerySuggestionsBlockListCommandOutput | UpdateQuerySuggestionsConfigCommandOutput | UpdateThesaurusCommandOutput;
|
|
79
84
|
/**
|
|
80
85
|
* @public
|
|
81
86
|
*/
|
|
@@ -56,7 +56,7 @@ export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEnt
|
|
|
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 ResourceAlreadyExistException} (client fault)
|
|
62
62
|
* <p>The resource you want to use already exists. Please check you have provided the
|
|
@@ -56,7 +56,7 @@ export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePerso
|
|
|
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 ResourceAlreadyExistException} (client fault)
|
|
62
62
|
* <p>The resource you want to use already exists. Please check you have provided the
|