@aws-sdk/client-kendra 3.699.0 → 3.709.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/dist-cjs/index.js +2 -1
- package/dist-es/models/models_0.js +1 -0
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +1 -0
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +1 -0
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +1 -0
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +6 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFaqCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +3 -4
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFaqCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIndexCommand.d.ts +1 -1
- package/dist-types/commands/ListFaqsCommand.d.ts +1 -1
- package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/QueryCommand.d.ts +7 -0
- package/dist-types/commands/RetrieveCommand.d.ts +7 -0
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +126 -66
- package/dist-types/models/models_1.d.ts +55 -19
- package/dist-types/ts3.4/models/models_0.d.ts +4 -0
- package/package.json +35 -35
package/dist-cjs/index.js
CHANGED
|
@@ -750,7 +750,8 @@ __name(_FeaturedResultsConflictException, "FeaturedResultsConflictException");
|
|
|
750
750
|
var FeaturedResultsConflictException = _FeaturedResultsConflictException;
|
|
751
751
|
var IndexEdition = {
|
|
752
752
|
DEVELOPER_EDITION: "DEVELOPER_EDITION",
|
|
753
|
-
ENTERPRISE_EDITION: "ENTERPRISE_EDITION"
|
|
753
|
+
ENTERPRISE_EDITION: "ENTERPRISE_EDITION",
|
|
754
|
+
GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION"
|
|
754
755
|
};
|
|
755
756
|
var UserContextPolicy = {
|
|
756
757
|
ATTRIBUTE_FILTER: "ATTRIBUTE_FILTER",
|
|
@@ -353,6 +353,7 @@ export class FeaturedResultsConflictException extends __BaseException {
|
|
|
353
353
|
export const IndexEdition = {
|
|
354
354
|
DEVELOPER_EDITION: "DEVELOPER_EDITION",
|
|
355
355
|
ENTERPRISE_EDITION: "ENTERPRISE_EDITION",
|
|
356
|
+
GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION",
|
|
356
357
|
};
|
|
357
358
|
export const UserContextPolicy = {
|
|
358
359
|
ATTRIBUTE_FILTER: "ATTRIBUTE_FILTER",
|
|
@@ -59,6 +59,7 @@ declare const BatchDeleteDocumentCommand_base: {
|
|
|
59
59
|
* // FailedDocuments: [ // BatchDeleteDocumentResponseFailedDocuments
|
|
60
60
|
* // { // BatchDeleteDocumentResponseFailedDocument
|
|
61
61
|
* // Id: "STRING_VALUE",
|
|
62
|
+
* // DataSourceId: "STRING_VALUE",
|
|
62
63
|
* // ErrorCode: "InternalError" || "InvalidRequest",
|
|
63
64
|
* // ErrorMessage: "STRING_VALUE",
|
|
64
65
|
* // },
|
|
@@ -69,6 +69,7 @@ declare const BatchGetDocumentStatusCommand_base: {
|
|
|
69
69
|
* // Errors: [ // BatchGetDocumentStatusResponseErrors
|
|
70
70
|
* // { // BatchGetDocumentStatusResponseError
|
|
71
71
|
* // DocumentId: "STRING_VALUE",
|
|
72
|
+
* // DataSourceId: "STRING_VALUE",
|
|
72
73
|
* // ErrorCode: "InternalError" || "InvalidRequest",
|
|
73
74
|
* // ErrorMessage: "STRING_VALUE",
|
|
74
75
|
* // },
|
|
@@ -166,6 +166,7 @@ declare const BatchPutDocumentCommand_base: {
|
|
|
166
166
|
* // FailedDocuments: [ // BatchPutDocumentResponseFailedDocuments
|
|
167
167
|
* // { // BatchPutDocumentResponseFailedDocument
|
|
168
168
|
* // Id: "STRING_VALUE",
|
|
169
|
+
* // DataSourceId: "STRING_VALUE",
|
|
169
170
|
* // ErrorCode: "InternalError" || "InvalidRequest",
|
|
170
171
|
* // ErrorMessage: "STRING_VALUE",
|
|
171
172
|
* // },
|
|
@@ -46,6 +46,12 @@ declare const CreateAccessControlConfigurationCommand_base: {
|
|
|
46
46
|
* synchronize your data source. Amazon Kendra currently only supports access control
|
|
47
47
|
* configuration for S3 data sources and documents indexed using the
|
|
48
48
|
* <code>BatchPutDocument</code> API.</p>
|
|
49
|
+
* <important>
|
|
50
|
+
* <p>You can't configure access control using
|
|
51
|
+
* <code>CreateAccessControlConfiguration</code> for an Amazon Kendra Gen AI Enterprise
|
|
52
|
+
* Edition index. Amazon Kendra will return a <code>ValidationException</code> error for a
|
|
53
|
+
* <code>Gen_AI_ENTERPRISE_EDITION</code> index.</p>
|
|
54
|
+
* </important>
|
|
49
55
|
* @example
|
|
50
56
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
57
|
* ```javascript
|
|
@@ -45,7 +45,7 @@ declare const CreateIndexCommand_base: {
|
|
|
45
45
|
* const client = new KendraClient(config);
|
|
46
46
|
* const input = { // CreateIndexRequest
|
|
47
47
|
* Name: "STRING_VALUE", // required
|
|
48
|
-
* Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
|
|
48
|
+
* Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
|
|
49
49
|
* RoleArn: "STRING_VALUE", // required
|
|
50
50
|
* ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
|
|
51
51
|
* KmsKeyId: "STRING_VALUE",
|
|
@@ -27,7 +27,7 @@ declare const DeleteFaqCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Removes
|
|
30
|
+
* <p>Removes a FAQ from an index.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,10 +27,9 @@ declare const DeleteIndexCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an Amazon Kendra index. An exception is not thrown if the index is
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* <code>DELETING</code>.</p>
|
|
30
|
+
* <p>Deletes an Amazon Kendra index. An exception is not thrown if the index is already
|
|
31
|
+
* being deleted. While the index is being deleted, the <code>Status</code> field returned by a
|
|
32
|
+
* call to the <code>DescribeIndex</code> API is set to <code>DELETING</code>.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DeletePrincipalMappingCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a group so that all users
|
|
30
|
+
* <p>Deletes a group so that all users that belong to the group can no
|
|
31
31
|
* longer access documents only available to that group.</p>
|
|
32
32
|
* <p>For example, after deleting the group "Summer Interns", all interns who belonged to
|
|
33
33
|
* that group no longer see intern-only documents in their search results.</p>
|
|
@@ -27,7 +27,7 @@ declare const DescribeFaqCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets information about
|
|
30
|
+
* <p>Gets information about a FAQ.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -42,7 +42,7 @@ declare const DescribeIndexCommand_base: {
|
|
|
42
42
|
* // { // DescribeIndexResponse
|
|
43
43
|
* // Name: "STRING_VALUE",
|
|
44
44
|
* // Id: "STRING_VALUE",
|
|
45
|
-
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
|
|
45
|
+
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
|
|
46
46
|
* // RoleArn: "STRING_VALUE",
|
|
47
47
|
* // ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
|
|
48
48
|
* // KmsKeyId: "STRING_VALUE",
|
|
@@ -27,7 +27,7 @@ declare const ListFaqsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets a list of
|
|
30
|
+
* <p>Gets a list of FAQs associated with an index.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -45,7 +45,7 @@ declare const ListIndicesCommand_base: {
|
|
|
45
45
|
* // { // IndexConfigurationSummary
|
|
46
46
|
* // Name: "STRING_VALUE",
|
|
47
47
|
* // Id: "STRING_VALUE",
|
|
48
|
-
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
|
|
48
|
+
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
|
|
49
49
|
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
50
50
|
* // UpdatedAt: new Date("TIMESTAMP"), // required
|
|
51
51
|
* // Status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING" || "SYSTEM_UPDATING", // required
|
|
@@ -27,8 +27,8 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets a list of tags associated with a
|
|
31
|
-
* can have tags associated with them.</p>
|
|
30
|
+
* <p>Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and
|
|
31
|
+
* other resources can have tags associated with them.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -57,6 +57,13 @@ declare const QueryCommand_base: {
|
|
|
57
57
|
* results. If you filter result type to only question-answers, a maximum of four results are
|
|
58
58
|
* returned. If you filter result type to only answers, a maximum of three results are
|
|
59
59
|
* returned.</p>
|
|
60
|
+
* <important>
|
|
61
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
|
|
62
|
+
* <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If you're
|
|
63
|
+
* using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
64
|
+
* <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
|
|
65
|
+
* <code>ValidationException</code> error.</p>
|
|
66
|
+
* </important>
|
|
60
67
|
* @example
|
|
61
68
|
* Use a bare-bones client and the command you need to make an API call.
|
|
62
69
|
* ```javascript
|
|
@@ -63,6 +63,13 @@ declare const RetrieveCommand_base: {
|
|
|
63
63
|
* units</a> that you set for your index. For more information on what's included
|
|
64
64
|
* in a single capacity unit and the default base capacity for an index, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting
|
|
65
65
|
* capacity</a>.</p>
|
|
66
|
+
* <important>
|
|
67
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
|
|
68
|
+
* <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If
|
|
69
|
+
* you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
70
|
+
* <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
|
|
71
|
+
* <code>ValidationException</code> error.</p>
|
|
72
|
+
* </important>
|
|
66
73
|
* @example
|
|
67
74
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
75
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Adds the specified tag to the specified index, FAQ,
|
|
31
|
-
* already exists, the existing value is replaced with the new value.</p>
|
|
30
|
+
* <p>Adds the specified tag to the specified index, FAQ, data source, or other resource. If
|
|
31
|
+
* the tag already exists, the existing value is replaced with the new value.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const UntagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Removes a tag from an index, FAQ, or
|
|
30
|
+
* <p>Removes a tag from an index, FAQ, data source, or other resource.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -46,6 +46,12 @@ declare const UpdateAccessControlConfigurationCommand_base: {
|
|
|
46
46
|
* apply the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code>
|
|
47
47
|
* file. Amazon Kendra currently only supports access control configuration for S3
|
|
48
48
|
* data sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
|
|
49
|
+
* <important>
|
|
50
|
+
* <p>You can't configure access control using
|
|
51
|
+
* <code>CreateAccessControlConfiguration</code> for an Amazon Kendra Gen AI Enterprise
|
|
52
|
+
* Edition index. Amazon Kendra will return a <code>ValidationException</code> error for a
|
|
53
|
+
* <code>Gen_AI_ENTERPRISE_EDITION</code> index.</p>
|
|
54
|
+
* </important>
|
|
49
55
|
* @example
|
|
50
56
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
57
|
* ```javascript
|
|
@@ -709,6 +709,16 @@ export interface DataSourceGroup {
|
|
|
709
709
|
* </li>
|
|
710
710
|
* </ul>
|
|
711
711
|
* <p>If you provide both, an exception is thrown.</p>
|
|
712
|
+
* <important>
|
|
713
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can use
|
|
714
|
+
* <code>UserId</code>, <code>Groups</code>, and <code>DataSourceGroups</code> to filter
|
|
715
|
+
* content. If you set the <code>UserId</code> to a particular user ID, it also includes
|
|
716
|
+
* all public documents.</p>
|
|
717
|
+
* <p>Amazon Kendra Gen AI Enterprise Edition indices don't support token based document filtering.
|
|
718
|
+
* If you're using an Amazon Kendra Gen AI Enterprise Edition index, Amazon Kendra returns a
|
|
719
|
+
* <code>ValidationException</code> error if the <code>Token</code> field has a non-null
|
|
720
|
+
* value.</p>
|
|
721
|
+
* </important>
|
|
712
722
|
* @public
|
|
713
723
|
*/
|
|
714
724
|
export interface UserContext {
|
|
@@ -790,7 +800,8 @@ export interface BasicAuthenticationConfiguration {
|
|
|
790
800
|
*/
|
|
791
801
|
Port: number | undefined;
|
|
792
802
|
/**
|
|
793
|
-
* <p>
|
|
803
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a
|
|
804
|
+
* secret to store your credentials in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
|
|
794
805
|
* </p>
|
|
795
806
|
* <p>You use a secret if basic authentication credentials are required to connect to a
|
|
796
807
|
* website. The secret stores your credentials of user name and password.</p>
|
|
@@ -876,6 +887,11 @@ export interface BatchDeleteDocumentResponseFailedDocument {
|
|
|
876
887
|
* @public
|
|
877
888
|
*/
|
|
878
889
|
Id?: string | undefined;
|
|
890
|
+
/**
|
|
891
|
+
* <p> The identifier of the data source connector that the document belongs to. </p>
|
|
892
|
+
* @public
|
|
893
|
+
*/
|
|
894
|
+
DataSourceId?: string | undefined;
|
|
879
895
|
/**
|
|
880
896
|
* <p>The error code for why the document couldn't be removed from the index.</p>
|
|
881
897
|
* @public
|
|
@@ -1082,6 +1098,12 @@ export interface BatchGetDocumentStatusResponseError {
|
|
|
1082
1098
|
* @public
|
|
1083
1099
|
*/
|
|
1084
1100
|
DocumentId?: string | undefined;
|
|
1101
|
+
/**
|
|
1102
|
+
* <p> The identifier of the data source connector that the failed document belongs to.
|
|
1103
|
+
* </p>
|
|
1104
|
+
* @public
|
|
1105
|
+
*/
|
|
1106
|
+
DataSourceId?: string | undefined;
|
|
1085
1107
|
/**
|
|
1086
1108
|
* <p>Indicates the source of the error.</p>
|
|
1087
1109
|
* @public
|
|
@@ -1261,8 +1283,8 @@ export interface HookConfiguration {
|
|
|
1261
1283
|
*/
|
|
1262
1284
|
InvocationCondition?: DocumentAttributeCondition | undefined;
|
|
1263
1285
|
/**
|
|
1264
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
1265
|
-
* during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
1286
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function
|
|
1287
|
+
* during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">an IAM roles for Amazon Kendra</a>.</p>
|
|
1266
1288
|
* @public
|
|
1267
1289
|
*/
|
|
1268
1290
|
LambdaArn: string | undefined;
|
|
@@ -1304,10 +1326,10 @@ export interface CustomDocumentEnrichmentConfiguration {
|
|
|
1304
1326
|
*/
|
|
1305
1327
|
PostExtractionHookConfiguration?: HookConfiguration | undefined;
|
|
1306
1328
|
/**
|
|
1307
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
1329
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to run
|
|
1308
1330
|
* <code>PreExtractionHookConfiguration</code> and
|
|
1309
1331
|
* <code>PostExtractionHookConfiguration</code> for altering document metadata and
|
|
1310
|
-
* content during the document ingestion process. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
1332
|
+
* content during the document ingestion process. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">an IAM roles for Amazon Kendra</a>.</p>
|
|
1311
1333
|
* @public
|
|
1312
1334
|
*/
|
|
1313
1335
|
RoleArn?: string | undefined;
|
|
@@ -1522,6 +1544,12 @@ export interface BatchPutDocumentResponseFailedDocument {
|
|
|
1522
1544
|
* @public
|
|
1523
1545
|
*/
|
|
1524
1546
|
Id?: string | undefined;
|
|
1547
|
+
/**
|
|
1548
|
+
* <p> The identifier of the data source connector that the failed document belongs to.
|
|
1549
|
+
* </p>
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1552
|
+
DataSourceId?: string | undefined;
|
|
1525
1553
|
/**
|
|
1526
1554
|
* <p>The type of error that caused the document to fail to be indexed.</p>
|
|
1527
1555
|
* @public
|
|
@@ -1992,7 +2020,8 @@ export interface ProxyConfiguration {
|
|
|
1992
2020
|
*/
|
|
1993
2021
|
Port: number | undefined;
|
|
1994
2022
|
/**
|
|
1995
|
-
* <p>
|
|
2023
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a
|
|
2024
|
+
* secret to store your credentials in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
|
|
1996
2025
|
* </p>
|
|
1997
2026
|
* <p>The credentials are optional. You use a secret if web proxy credentials are required
|
|
1998
2027
|
* to connect to a website host. Amazon Kendra currently support basic authentication
|
|
@@ -2265,13 +2294,12 @@ export interface ConnectionConfiguration {
|
|
|
2265
2294
|
*/
|
|
2266
2295
|
TableName: string | undefined;
|
|
2267
2296
|
/**
|
|
2268
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
2269
|
-
* credentials should be a user
|
|
2297
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that stores
|
|
2298
|
+
* the credentials. The credentials should be a user-password pair. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html">Using a
|
|
2270
2299
|
* Database Data Source</a>. For more information about Secrets Manager, see
|
|
2271
|
-
*
|
|
2272
|
-
* Is Secrets Manager</a> in the <i>
|
|
2273
|
-
*
|
|
2274
|
-
* </i> user guide.</p>
|
|
2300
|
+
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html"> What
|
|
2301
|
+
* Is Secrets Manager</a> in the <i>Secrets Manager</i>
|
|
2302
|
+
* user guide.</p>
|
|
2275
2303
|
* @public
|
|
2276
2304
|
*/
|
|
2277
2305
|
SecretArn: string | undefined;
|
|
@@ -2986,7 +3014,7 @@ export interface OneDriveUsers {
|
|
|
2986
3014
|
/**
|
|
2987
3015
|
* <p>A list of users whose documents should be indexed. Specify the user names in email
|
|
2988
3016
|
* format, for example, <code>username@tenantdomain</code>. If you need to index the
|
|
2989
|
-
* documents of more than
|
|
3017
|
+
* documents of more than 10 users, use the <code>OneDriveUserS3Path</code> field to
|
|
2990
3018
|
* specify the location of a file containing a list of users.</p>
|
|
2991
3019
|
* @public
|
|
2992
3020
|
*/
|
|
@@ -4553,15 +4581,15 @@ export interface DataSourceConfiguration {
|
|
|
4553
4581
|
TemplateConfiguration?: TemplateConfiguration | undefined;
|
|
4554
4582
|
}
|
|
4555
4583
|
/**
|
|
4556
|
-
* <p>A
|
|
4557
|
-
*
|
|
4558
|
-
* = + - @.</p>
|
|
4584
|
+
* <p>A key-value pair that identifies or categorizes an index, FAQ,
|
|
4585
|
+
* data source, or other resource. TA tag key and value can consist of Unicode letters,
|
|
4586
|
+
* digits, white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
4559
4587
|
* @public
|
|
4560
4588
|
*/
|
|
4561
4589
|
export interface Tag {
|
|
4562
4590
|
/**
|
|
4563
|
-
* <p>The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ,
|
|
4564
|
-
* data source.</p>
|
|
4591
|
+
* <p>The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ,
|
|
4592
|
+
* data source, or other resource.</p>
|
|
4565
4593
|
* @public
|
|
4566
4594
|
*/
|
|
4567
4595
|
Key: string | undefined;
|
|
@@ -4860,7 +4888,7 @@ export interface CreateFaqRequest {
|
|
|
4860
4888
|
S3Path: S3Path | undefined;
|
|
4861
4889
|
/**
|
|
4862
4890
|
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
4863
|
-
* the S3 bucket that contains the
|
|
4891
|
+
* the S3 bucket that contains the FAQ file. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for
|
|
4864
4892
|
* Amazon Kendra</a>.</p>
|
|
4865
4893
|
* @public
|
|
4866
4894
|
*/
|
|
@@ -5141,6 +5169,7 @@ export declare class FeaturedResultsConflictException extends __BaseException {
|
|
|
5141
5169
|
export declare const IndexEdition: {
|
|
5142
5170
|
readonly DEVELOPER_EDITION: "DEVELOPER_EDITION";
|
|
5143
5171
|
readonly ENTERPRISE_EDITION: "ENTERPRISE_EDITION";
|
|
5172
|
+
readonly GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION";
|
|
5144
5173
|
};
|
|
5145
5174
|
/**
|
|
5146
5175
|
* @public
|
|
@@ -5185,12 +5214,10 @@ export declare const UserGroupResolutionMode: {
|
|
|
5185
5214
|
*/
|
|
5186
5215
|
export type UserGroupResolutionMode = (typeof UserGroupResolutionMode)[keyof typeof UserGroupResolutionMode];
|
|
5187
5216
|
/**
|
|
5188
|
-
* <p>Provides the configuration information to get users and groups from
|
|
5189
|
-
*
|
|
5190
|
-
*
|
|
5191
|
-
*
|
|
5192
|
-
* map users to their groups so that you only need to provide the user ID when you issue the
|
|
5193
|
-
* query.</p>
|
|
5217
|
+
* <p>Provides the configuration information to get users and groups from an IAM Identity Center identity source. This is useful for user context filtering, where search
|
|
5218
|
+
* results are filtered based on the user or their group access to documents. You can also use
|
|
5219
|
+
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping</a> API to map users to their groups so that you only need to
|
|
5220
|
+
* provide the user ID when you issue the query.</p>
|
|
5194
5221
|
* <p>To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started with an IAM Identity Center identity source</a>. You must also grant the required permissions to
|
|
5195
5222
|
* use IAM Identity Center with Amazon Kendra. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso">IAM roles for IAM Identity Center</a>.</p>
|
|
5196
5223
|
* <p>Amazon Kendra currently does not support using
|
|
@@ -5198,13 +5225,16 @@ export type UserGroupResolutionMode = (typeof UserGroupResolutionMode)[keyof typ
|
|
|
5198
5225
|
* member account for your IAM Identity Center identify source. You must create your index in
|
|
5199
5226
|
* the management account for the organization in order to use
|
|
5200
5227
|
* <code>UserGroupResolutionConfiguration</code>.</p>
|
|
5228
|
+
* <important>
|
|
5229
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
|
5230
|
+
* <code>UserGroupResolutionConfiguration</code> isn't supported.</p>
|
|
5231
|
+
* </important>
|
|
5201
5232
|
* @public
|
|
5202
5233
|
*/
|
|
5203
5234
|
export interface UserGroupResolutionConfiguration {
|
|
5204
5235
|
/**
|
|
5205
|
-
* <p>The identity store provider (mode) you want to use to get users and groups.
|
|
5206
|
-
* IAM Identity Center
|
|
5207
|
-
* must exist in an IAM Identity Center identity source in order to use this mode.</p>
|
|
5236
|
+
* <p>The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in
|
|
5237
|
+
* an IAM Identity Center identity source in order to use this mode.</p>
|
|
5208
5238
|
* @public
|
|
5209
5239
|
*/
|
|
5210
5240
|
UserGroupResolutionMode: UserGroupResolutionMode | undefined;
|
|
@@ -5280,6 +5310,11 @@ export interface JwtTokenTypeConfiguration {
|
|
|
5280
5310
|
}
|
|
5281
5311
|
/**
|
|
5282
5312
|
* <p>Provides the configuration information for a token.</p>
|
|
5313
|
+
* <important>
|
|
5314
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
5315
|
+
* <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns
|
|
5316
|
+
* a <code>ValidationException</code> error.</p>
|
|
5317
|
+
* </important>
|
|
5283
5318
|
* @public
|
|
5284
5319
|
*/
|
|
5285
5320
|
export interface UserTokenConfiguration {
|
|
@@ -5306,18 +5341,20 @@ export interface CreateIndexRequest {
|
|
|
5306
5341
|
/**
|
|
5307
5342
|
* <p>The Amazon Kendra edition to use for the index. Choose <code>DEVELOPER_EDITION</code>
|
|
5308
5343
|
* for indexes intended for development, testing, or proof of concept. Use
|
|
5309
|
-
* <code>ENTERPRISE_EDITION</code> for production.
|
|
5310
|
-
* an index, it can't be
|
|
5344
|
+
* <code>ENTERPRISE_EDITION</code> for production. Use <code>GEN_AI_ENTERPRISE_EDITION</code>
|
|
5345
|
+
* for creating generative AI applications. Once you set the edition for an index, it can't be
|
|
5346
|
+
* changed. </p>
|
|
5311
5347
|
* <p>The <code>Edition</code> parameter is optional. If you don't supply a value, the default
|
|
5312
5348
|
* is <code>ENTERPRISE_EDITION</code>.</p>
|
|
5313
|
-
* <p>For more information on quota limits for
|
|
5349
|
+
* <p>For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and
|
|
5350
|
+
* Developer Edition indices, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</p>
|
|
5314
5351
|
* @public
|
|
5315
5352
|
*/
|
|
5316
5353
|
Edition?: IndexEdition | undefined;
|
|
5317
5354
|
/**
|
|
5318
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
5319
|
-
* Amazon CloudWatch logs and metrics. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles
|
|
5320
|
-
*
|
|
5355
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
5356
|
+
* your Amazon CloudWatch logs and metrics. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles
|
|
5357
|
+
* for Amazon Kendra</a>.</p>
|
|
5321
5358
|
* @public
|
|
5322
5359
|
*/
|
|
5323
5360
|
RoleArn: string | undefined;
|
|
@@ -5347,11 +5384,23 @@ export interface CreateIndexRequest {
|
|
|
5347
5384
|
Tags?: Tag[] | undefined;
|
|
5348
5385
|
/**
|
|
5349
5386
|
* <p>The user token configuration.</p>
|
|
5387
|
+
* <important>
|
|
5388
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
5389
|
+
* <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns
|
|
5390
|
+
* a <code>ValidationException</code> error.</p>
|
|
5391
|
+
* </important>
|
|
5350
5392
|
* @public
|
|
5351
5393
|
*/
|
|
5352
5394
|
UserTokenConfigurations?: UserTokenConfiguration[] | undefined;
|
|
5353
5395
|
/**
|
|
5354
5396
|
* <p>The user context policy.</p>
|
|
5397
|
+
* <important>
|
|
5398
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
|
|
5399
|
+
* <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If you're
|
|
5400
|
+
* using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
5401
|
+
* <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
|
|
5402
|
+
* <code>ValidationException</code> error.</p>
|
|
5403
|
+
* </important>
|
|
5355
5404
|
* <dl>
|
|
5356
5405
|
* <dt>ATTRIBUTE_FILTER</dt>
|
|
5357
5406
|
* <dd>
|
|
@@ -5371,9 +5420,14 @@ export interface CreateIndexRequest {
|
|
|
5371
5420
|
*/
|
|
5372
5421
|
UserContextPolicy?: UserContextPolicy | undefined;
|
|
5373
5422
|
/**
|
|
5374
|
-
* <p>Gets users and groups from IAM Identity Center
|
|
5375
|
-
*
|
|
5376
|
-
* search results are filtered based on the user or their group access to
|
|
5423
|
+
* <p>Gets users and groups from IAM Identity Center identity source. To configure this,
|
|
5424
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering,
|
|
5425
|
+
* where search results are filtered based on the user or their group access to
|
|
5426
|
+
* documents.</p>
|
|
5427
|
+
* <important>
|
|
5428
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
|
5429
|
+
* <code>UserGroupResolutionConfiguration</code> isn't supported.</p>
|
|
5430
|
+
* </important>
|
|
5377
5431
|
* @public
|
|
5378
5432
|
*/
|
|
5379
5433
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined;
|
|
@@ -5812,8 +5866,8 @@ export interface DescribeDataSourceResponse {
|
|
|
5812
5866
|
*/
|
|
5813
5867
|
Schedule?: string | undefined;
|
|
5814
5868
|
/**
|
|
5815
|
-
* <p>The Amazon Resource Name (ARN) of the role with permission to
|
|
5816
|
-
* required resources.</p>
|
|
5869
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permission to
|
|
5870
|
+
* access the data source and required resources.</p>
|
|
5817
5871
|
* @public
|
|
5818
5872
|
*/
|
|
5819
5873
|
RoleArn?: string | undefined;
|
|
@@ -5958,10 +6012,10 @@ export interface DescribeExperienceResponse {
|
|
|
5958
6012
|
*/
|
|
5959
6013
|
Status?: ExperienceStatus | undefined;
|
|
5960
6014
|
/**
|
|
5961
|
-
* <p>
|
|
5962
|
-
* <code>Query</code> API, <code>QuerySuggestions</code> API,
|
|
6015
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permission to access
|
|
6016
|
+
* the <code>Query</code> API, <code>QuerySuggestions</code> API,
|
|
5963
6017
|
* <code>SubmitFeedback</code> API, and IAM Identity Center that stores
|
|
5964
|
-
* your
|
|
6018
|
+
* your users and groups information.</p>
|
|
5965
6019
|
* @public
|
|
5966
6020
|
*/
|
|
5967
6021
|
RoleArn?: string | undefined;
|
|
@@ -6047,8 +6101,8 @@ export interface DescribeFaqResponse {
|
|
|
6047
6101
|
*/
|
|
6048
6102
|
Status?: FaqStatus | undefined;
|
|
6049
6103
|
/**
|
|
6050
|
-
* <p>The Amazon Resource Name (ARN) of the role that provides access
|
|
6051
|
-
*
|
|
6104
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that provides access
|
|
6105
|
+
* to the S3 bucket containing the FAQ file.</p>
|
|
6052
6106
|
* @public
|
|
6053
6107
|
*/
|
|
6054
6108
|
RoleArn?: string | undefined;
|
|
@@ -6059,7 +6113,7 @@ export interface DescribeFaqResponse {
|
|
|
6059
6113
|
*/
|
|
6060
6114
|
ErrorMessage?: string | undefined;
|
|
6061
6115
|
/**
|
|
6062
|
-
* <p>The file format used
|
|
6116
|
+
* <p>The file format used for the FAQ file.</p>
|
|
6063
6117
|
* @public
|
|
6064
6118
|
*/
|
|
6065
6119
|
FileFormat?: FaqFileFormat | undefined;
|
|
@@ -6377,13 +6431,13 @@ export interface DocumentMetadataConfiguration {
|
|
|
6377
6431
|
Search?: Search | undefined;
|
|
6378
6432
|
}
|
|
6379
6433
|
/**
|
|
6380
|
-
* <p>Provides statistical information about the FAQ questions and answers
|
|
6434
|
+
* <p>Provides statistical information about the FAQ questions and answers for an
|
|
6381
6435
|
* index.</p>
|
|
6382
6436
|
* @public
|
|
6383
6437
|
*/
|
|
6384
6438
|
export interface FaqStatistics {
|
|
6385
6439
|
/**
|
|
6386
|
-
* <p>The total number of FAQ questions and answers
|
|
6440
|
+
* <p>The total number of FAQ questions and answers for an index.</p>
|
|
6387
6441
|
* @public
|
|
6388
6442
|
*/
|
|
6389
6443
|
IndexedQuestionAnswersCount: number | undefined;
|
|
@@ -6458,8 +6512,7 @@ export interface DescribeIndexResponse {
|
|
|
6458
6512
|
*/
|
|
6459
6513
|
Edition?: IndexEdition | undefined;
|
|
6460
6514
|
/**
|
|
6461
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that gives
|
|
6462
|
-
* Amazon Kendra permission to write to your Amazon CloudWatch logs.</p>
|
|
6515
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.</p>
|
|
6463
6516
|
* @public
|
|
6464
6517
|
*/
|
|
6465
6518
|
RoleArn?: string | undefined;
|
|
@@ -6530,9 +6583,9 @@ export interface DescribeIndexResponse {
|
|
|
6530
6583
|
*/
|
|
6531
6584
|
UserContextPolicy?: UserContextPolicy | undefined;
|
|
6532
6585
|
/**
|
|
6533
|
-
* <p>Whether you have enabled IAM Identity Center identity source for your
|
|
6534
|
-
*
|
|
6535
|
-
*
|
|
6586
|
+
* <p>Whether you have enabled IAM Identity Center identity source for your users and
|
|
6587
|
+
* groups. This is useful for user context filtering, where search results are filtered based
|
|
6588
|
+
* on the user or their group access to documents.</p>
|
|
6536
6589
|
* @public
|
|
6537
6590
|
*/
|
|
6538
6591
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined;
|
|
@@ -7882,7 +7935,7 @@ export interface ListExperiencesResponse {
|
|
|
7882
7935
|
*/
|
|
7883
7936
|
export interface ListFaqsRequest {
|
|
7884
7937
|
/**
|
|
7885
|
-
* <p>The index
|
|
7938
|
+
* <p>The index for the FAQs.</p>
|
|
7886
7939
|
* @public
|
|
7887
7940
|
*/
|
|
7888
7941
|
IndexId: string | undefined;
|
|
@@ -7958,7 +8011,7 @@ export interface ListFaqsResponse {
|
|
|
7958
8011
|
*/
|
|
7959
8012
|
NextToken?: string | undefined;
|
|
7960
8013
|
/**
|
|
7961
|
-
* <p>information about the FAQs
|
|
8014
|
+
* <p>Summary information about the FAQs for a specified index.</p>
|
|
7962
8015
|
* @public
|
|
7963
8016
|
*/
|
|
7964
8017
|
FaqSummaryItems?: FaqSummary[] | undefined;
|
|
@@ -8279,8 +8332,12 @@ export interface ListQuerySuggestionsBlockListsResponse {
|
|
|
8279
8332
|
*/
|
|
8280
8333
|
export interface ListTagsForResourceRequest {
|
|
8281
8334
|
/**
|
|
8282
|
-
* <p>The Amazon Resource Name (ARN) of the index, FAQ,
|
|
8283
|
-
* for
|
|
8335
|
+
* <p>The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to
|
|
8336
|
+
* get a list of tags for. For example, the ARN of an index is constructed as follows:
|
|
8337
|
+
* <i>arn:aws:kendra:your-region:your-account-id:index/index-id</i>
|
|
8338
|
+
* For information on how to construct an ARN for all types of Amazon Kendra resources, see
|
|
8339
|
+
* <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies">Resource
|
|
8340
|
+
* types</a>.</p>
|
|
8284
8341
|
* @public
|
|
8285
8342
|
*/
|
|
8286
8343
|
ResourceARN: string | undefined;
|
|
@@ -8290,7 +8347,7 @@ export interface ListTagsForResourceRequest {
|
|
|
8290
8347
|
*/
|
|
8291
8348
|
export interface ListTagsForResourceResponse {
|
|
8292
8349
|
/**
|
|
8293
|
-
* <p>A list of tags associated with the index, FAQ, or
|
|
8350
|
+
* <p>A list of tags associated with the index, FAQ, data source, or other resource.</p>
|
|
8294
8351
|
* @public
|
|
8295
8352
|
*/
|
|
8296
8353
|
Tags?: Tag[] | undefined;
|
|
@@ -8409,15 +8466,16 @@ export interface MemberUser {
|
|
|
8409
8466
|
UserId: string | undefined;
|
|
8410
8467
|
}
|
|
8411
8468
|
/**
|
|
8412
|
-
* <p>A list of users
|
|
8469
|
+
* <p>A list of users that belong to a group. This is useful for user context
|
|
8413
8470
|
* filtering, where search results are filtered based on the user or their group access to
|
|
8414
8471
|
* documents.</p>
|
|
8415
8472
|
* @public
|
|
8416
8473
|
*/
|
|
8417
8474
|
export interface GroupMembers {
|
|
8418
8475
|
/**
|
|
8419
|
-
* <p>A list of
|
|
8420
|
-
* "Engineering", and "Sales and Marketing" all belong to the group
|
|
8476
|
+
* <p>A list of users that belong to a group. This can also include sub groups. For example,
|
|
8477
|
+
* the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group
|
|
8478
|
+
* "Company A".</p>
|
|
8421
8479
|
* @public
|
|
8422
8480
|
*/
|
|
8423
8481
|
MemberGroups?: MemberGroup[] | undefined;
|
|
@@ -8465,8 +8523,9 @@ export interface PutPrincipalMappingRequest {
|
|
|
8465
8523
|
*/
|
|
8466
8524
|
GroupId: string | undefined;
|
|
8467
8525
|
/**
|
|
8468
|
-
* <p>The list that contains your users
|
|
8469
|
-
*
|
|
8526
|
+
* <p>The list that contains your users that belong the same group. This can include sub groups
|
|
8527
|
+
* that belong to a group.</p>
|
|
8528
|
+
* <p>For example, the group "Company A" includes the user "CEO" and the sub groups
|
|
8470
8529
|
* "Research", "Engineering", and "Sales and Marketing".</p>
|
|
8471
8530
|
* <p>If you have more than 1000 users and/or sub groups for a single group, you need to
|
|
8472
8531
|
* provide the path to the S3 file that lists your users and sub groups for a group. Your
|
|
@@ -8476,7 +8535,7 @@ export interface PutPrincipalMappingRequest {
|
|
|
8476
8535
|
*/
|
|
8477
8536
|
GroupMembers: GroupMembers | undefined;
|
|
8478
8537
|
/**
|
|
8479
|
-
* <p>The timestamp identifier you specify to ensure Amazon Kendra
|
|
8538
|
+
* <p>The timestamp identifier you specify to ensure Amazon Kendra doesn't override
|
|
8480
8539
|
* the latest <code>PUT</code> action with previous actions. The highest number ID, which
|
|
8481
8540
|
* is the ordering ID, is the latest action you want to process and apply on top of other
|
|
8482
8541
|
* actions with lower number IDs. This prevents previous actions with lower number IDs from
|
|
@@ -8492,9 +8551,10 @@ export interface PutPrincipalMappingRequest {
|
|
|
8492
8551
|
*/
|
|
8493
8552
|
OrderingId?: number | undefined;
|
|
8494
8553
|
/**
|
|
8495
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
8496
|
-
* your list of users
|
|
8497
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds">IAM roles for
|
|
8554
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that has access to the
|
|
8555
|
+
* S3 file that contains your list of users that belong to a group.</p>
|
|
8556
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds">IAM roles for
|
|
8557
|
+
* Amazon Kendra</a>.</p>
|
|
8498
8558
|
* @public
|
|
8499
8559
|
*/
|
|
8500
8560
|
RoleArn?: string | undefined;
|
|
@@ -454,13 +454,18 @@ export interface SubmitFeedbackRequest {
|
|
|
454
454
|
*/
|
|
455
455
|
export interface TagResourceRequest {
|
|
456
456
|
/**
|
|
457
|
-
* <p>The Amazon Resource Name (ARN) of the index, FAQ,
|
|
457
|
+
* <p>The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to add a tag.
|
|
458
|
+
* For example, the ARN of an index is constructed as follows:
|
|
459
|
+
* <i>arn:aws:kendra:your-region:your-account-id:index/index-id</i>
|
|
460
|
+
* For information on how to construct an ARN for all types of Amazon Kendra resources, see
|
|
461
|
+
* <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies">Resource
|
|
462
|
+
* types</a>.</p>
|
|
458
463
|
* @public
|
|
459
464
|
*/
|
|
460
465
|
ResourceARN: string | undefined;
|
|
461
466
|
/**
|
|
462
|
-
* <p>A list of tag keys to add to the index, FAQ, or
|
|
463
|
-
* existing value is replaced with the new value.</p>
|
|
467
|
+
* <p>A list of tag keys to add to the index, FAQ, data source, or other resource. If a tag already
|
|
468
|
+
* exists, the existing value is replaced with the new value.</p>
|
|
464
469
|
* @public
|
|
465
470
|
*/
|
|
466
471
|
Tags: Tag[] | undefined;
|
|
@@ -475,14 +480,18 @@ export interface TagResourceResponse {
|
|
|
475
480
|
*/
|
|
476
481
|
export interface UntagResourceRequest {
|
|
477
482
|
/**
|
|
478
|
-
* <p>The Amazon Resource Name (ARN) of the index, FAQ,
|
|
479
|
-
*
|
|
483
|
+
* <p>The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to remove a tag.
|
|
484
|
+
* For example, the ARN of an index is constructed as follows:
|
|
485
|
+
* <i>arn:aws:kendra:your-region:your-account-id:index/index-id</i>
|
|
486
|
+
* For information on how to construct an ARN for all types of Amazon Kendra resources, see
|
|
487
|
+
* <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies">Resource
|
|
488
|
+
* types</a>.</p>
|
|
480
489
|
* @public
|
|
481
490
|
*/
|
|
482
491
|
ResourceARN: string | undefined;
|
|
483
492
|
/**
|
|
484
|
-
* <p>A list of tag keys to remove from the index, FAQ, or
|
|
485
|
-
* exist
|
|
493
|
+
* <p>A list of tag keys to remove from the index, FAQ, data source, or other resource. If a tag
|
|
494
|
+
* key doesn't exist for the resource, it is ignored.</p>
|
|
486
495
|
* @public
|
|
487
496
|
*/
|
|
488
497
|
TagKeys: string[] | undefined;
|
|
@@ -576,8 +585,8 @@ export interface UpdateDataSourceRequest {
|
|
|
576
585
|
*/
|
|
577
586
|
Schedule?: string | undefined;
|
|
578
587
|
/**
|
|
579
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
580
|
-
* required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
588
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
589
|
+
* the data source and required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
581
590
|
* @public
|
|
582
591
|
*/
|
|
583
592
|
RoleArn?: string | undefined;
|
|
@@ -620,9 +629,9 @@ export interface UpdateExperienceRequest {
|
|
|
620
629
|
*/
|
|
621
630
|
IndexId: string | undefined;
|
|
622
631
|
/**
|
|
623
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
624
|
-
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
625
|
-
* API, and IAM Identity Center that stores your
|
|
632
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
633
|
+
* the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
634
|
+
* API, and IAM Identity Center that stores your users and groups information.
|
|
626
635
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
627
636
|
* @public
|
|
628
637
|
*/
|
|
@@ -741,18 +750,35 @@ export interface UpdateIndexRequest {
|
|
|
741
750
|
CapacityUnits?: CapacityUnitsConfiguration | undefined;
|
|
742
751
|
/**
|
|
743
752
|
* <p>The user token configuration.</p>
|
|
753
|
+
* <important>
|
|
754
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
755
|
+
* <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns
|
|
756
|
+
* a <code>ValidationException</code> error.</p>
|
|
757
|
+
* </important>
|
|
744
758
|
* @public
|
|
745
759
|
*/
|
|
746
760
|
UserTokenConfigurations?: UserTokenConfiguration[] | undefined;
|
|
747
761
|
/**
|
|
748
762
|
* <p>The user context policy.</p>
|
|
763
|
+
* <important>
|
|
764
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
|
|
765
|
+
* <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If you're
|
|
766
|
+
* using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
767
|
+
* <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
|
|
768
|
+
* <code>ValidationException</code> error.</p>
|
|
769
|
+
* </important>
|
|
749
770
|
* @public
|
|
750
771
|
*/
|
|
751
772
|
UserContextPolicy?: UserContextPolicy | undefined;
|
|
752
773
|
/**
|
|
753
|
-
* <p>Gets users and groups from IAM Identity Center
|
|
754
|
-
*
|
|
755
|
-
* search results are filtered based on the user or their group access to
|
|
774
|
+
* <p>Gets users and groups from IAM Identity Center identity source. To configure this,
|
|
775
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering,
|
|
776
|
+
* where search results are filtered based on the user or their group access to
|
|
777
|
+
* documents.</p>
|
|
778
|
+
* <important>
|
|
779
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
|
780
|
+
* <code>UserGroupResolutionConfiguration</code> isn't supported.</p>
|
|
781
|
+
* </important>
|
|
756
782
|
* @public
|
|
757
783
|
*/
|
|
758
784
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined;
|
|
@@ -1007,7 +1033,7 @@ export interface FacetResult {
|
|
|
1007
1033
|
* "Department", you can filter documents that belong to the "HR" department. You would use
|
|
1008
1034
|
* the <code>EqualsTo</code> operation to filter results or documents with "Department" equals
|
|
1009
1035
|
* to "HR".</p>
|
|
1010
|
-
* <p>You can use <code>AndAllFilters</code> and <code>
|
|
1036
|
+
* <p>You can use <code>AndAllFilters</code> and <code>OrAllFilters</code> in combination with
|
|
1011
1037
|
* each other or with other operations such as <code>EqualsTo</code>. For example:</p>
|
|
1012
1038
|
* <p>
|
|
1013
1039
|
* <code>AndAllFilters</code>
|
|
@@ -1019,7 +1045,7 @@ export interface FacetResult {
|
|
|
1019
1045
|
* </li>
|
|
1020
1046
|
* <li>
|
|
1021
1047
|
* <p>
|
|
1022
|
-
* <code>
|
|
1048
|
+
* <code>OrAllFilters</code>
|
|
1023
1049
|
* </p>
|
|
1024
1050
|
* <ul>
|
|
1025
1051
|
* <li>
|
|
@@ -1030,8 +1056,8 @@ export interface FacetResult {
|
|
|
1030
1056
|
* </li>
|
|
1031
1057
|
* </ul>
|
|
1032
1058
|
* <p>This example filters results or documents that belong to the HR department
|
|
1033
|
-
* <
|
|
1034
|
-
* <
|
|
1059
|
+
* <code>AND</code> belong to projects that contain "new hires"
|
|
1060
|
+
* <code>OR</code> "new hiring" in the project name (must use
|
|
1035
1061
|
* <code>ContainAny</code> with <code>StringListValue</code>). This example is filtering
|
|
1036
1062
|
* with a depth of 2.</p>
|
|
1037
1063
|
* <p>You cannot filter more than a depth of 2, otherwise you receive a
|
|
@@ -1217,6 +1243,11 @@ export interface RetrieveRequest {
|
|
|
1217
1243
|
* <code>OrAllFilters</code> parameters contain a list of other filters.</p>
|
|
1218
1244
|
* <p>The <code>AttributeFilter</code> parameter means you can create a set of filtering
|
|
1219
1245
|
* rules that a document must satisfy to be included in the query results.</p>
|
|
1246
|
+
* <note>
|
|
1247
|
+
* <p>For Amazon Kendra Gen AI Enterprise Edition indices use <code>AttributeFilter</code> to
|
|
1248
|
+
* enable document filtering for end users using <code>_email_id</code> or include
|
|
1249
|
+
* public documents (<code>_email_id=null</code>).</p>
|
|
1250
|
+
* </note>
|
|
1220
1251
|
* @public
|
|
1221
1252
|
*/
|
|
1222
1253
|
AttributeFilter?: AttributeFilter | undefined;
|
|
@@ -1329,6 +1360,11 @@ export interface QueryRequest {
|
|
|
1329
1360
|
* <code>OrAllFilters</code> parameters contain a list of other filters.</p>
|
|
1330
1361
|
* <p>The <code>AttributeFilter</code> parameter means you can create a set of filtering rules
|
|
1331
1362
|
* that a document must satisfy to be included in the query results.</p>
|
|
1363
|
+
* <note>
|
|
1364
|
+
* <p>For Amazon Kendra Gen AI Enterprise Edition indices use <code>AttributeFilter</code> to
|
|
1365
|
+
* enable document filtering for end users using <code>_email_id</code> or include public
|
|
1366
|
+
* documents (<code>_email_id=null</code>).</p>
|
|
1367
|
+
* </note>
|
|
1332
1368
|
* @public
|
|
1333
1369
|
*/
|
|
1334
1370
|
AttributeFilter?: AttributeFilter | undefined;
|
|
@@ -221,6 +221,7 @@ export declare const ErrorCode: {
|
|
|
221
221
|
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
222
222
|
export interface BatchDeleteDocumentResponseFailedDocument {
|
|
223
223
|
Id?: string | undefined;
|
|
224
|
+
DataSourceId?: string | undefined;
|
|
224
225
|
ErrorCode?: ErrorCode | undefined;
|
|
225
226
|
ErrorMessage?: string | undefined;
|
|
226
227
|
}
|
|
@@ -271,6 +272,7 @@ export interface Status {
|
|
|
271
272
|
}
|
|
272
273
|
export interface BatchGetDocumentStatusResponseError {
|
|
273
274
|
DocumentId?: string | undefined;
|
|
275
|
+
DataSourceId?: string | undefined;
|
|
274
276
|
ErrorCode?: ErrorCode | undefined;
|
|
275
277
|
ErrorMessage?: string | undefined;
|
|
276
278
|
}
|
|
@@ -377,6 +379,7 @@ export interface BatchPutDocumentRequest {
|
|
|
377
379
|
}
|
|
378
380
|
export interface BatchPutDocumentResponseFailedDocument {
|
|
379
381
|
Id?: string | undefined;
|
|
382
|
+
DataSourceId?: string | undefined;
|
|
380
383
|
ErrorCode?: ErrorCode | undefined;
|
|
381
384
|
ErrorMessage?: string | undefined;
|
|
382
385
|
}
|
|
@@ -1111,6 +1114,7 @@ export declare class FeaturedResultsConflictException extends __BaseException {
|
|
|
1111
1114
|
export declare const IndexEdition: {
|
|
1112
1115
|
readonly DEVELOPER_EDITION: "DEVELOPER_EDITION";
|
|
1113
1116
|
readonly ENTERPRISE_EDITION: "ENTERPRISE_EDITION";
|
|
1117
|
+
readonly GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION";
|
|
1114
1118
|
};
|
|
1115
1119
|
export type IndexEdition = (typeof IndexEdition)[keyof typeof IndexEdition];
|
|
1116
1120
|
export interface ServerSideEncryptionConfiguration {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-kendra",
|
|
3
3
|
"description": "AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.709.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-kendra",
|
|
@@ -20,43 +20,43 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/client-sso-oidc": "3.
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/core": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
27
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
28
|
-
"@aws-sdk/middleware-logger": "3.
|
|
29
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
32
|
-
"@aws-sdk/types": "3.
|
|
33
|
-
"@aws-sdk/util-endpoints": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
36
|
-
"@smithy/config-resolver": "^3.0.
|
|
37
|
-
"@smithy/core": "^2.5.
|
|
38
|
-
"@smithy/fetch-http-handler": "^4.1.
|
|
39
|
-
"@smithy/hash-node": "^3.0.
|
|
40
|
-
"@smithy/invalid-dependency": "^3.0.
|
|
41
|
-
"@smithy/middleware-content-length": "^3.0.
|
|
42
|
-
"@smithy/middleware-endpoint": "^3.2.
|
|
43
|
-
"@smithy/middleware-retry": "^3.0.
|
|
44
|
-
"@smithy/middleware-serde": "^3.0.
|
|
45
|
-
"@smithy/middleware-stack": "^3.0.
|
|
46
|
-
"@smithy/node-config-provider": "^3.1.
|
|
47
|
-
"@smithy/node-http-handler": "^3.3.
|
|
48
|
-
"@smithy/protocol-http": "^4.1.
|
|
49
|
-
"@smithy/smithy-client": "^3.
|
|
50
|
-
"@smithy/types": "^3.7.
|
|
51
|
-
"@smithy/url-parser": "^3.0.
|
|
23
|
+
"@aws-sdk/client-sso-oidc": "3.709.0",
|
|
24
|
+
"@aws-sdk/client-sts": "3.709.0",
|
|
25
|
+
"@aws-sdk/core": "3.709.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.709.0",
|
|
27
|
+
"@aws-sdk/middleware-host-header": "3.709.0",
|
|
28
|
+
"@aws-sdk/middleware-logger": "3.709.0",
|
|
29
|
+
"@aws-sdk/middleware-recursion-detection": "3.709.0",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.709.0",
|
|
31
|
+
"@aws-sdk/region-config-resolver": "3.709.0",
|
|
32
|
+
"@aws-sdk/types": "3.709.0",
|
|
33
|
+
"@aws-sdk/util-endpoints": "3.709.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-browser": "3.709.0",
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.709.0",
|
|
36
|
+
"@smithy/config-resolver": "^3.0.13",
|
|
37
|
+
"@smithy/core": "^2.5.5",
|
|
38
|
+
"@smithy/fetch-http-handler": "^4.1.2",
|
|
39
|
+
"@smithy/hash-node": "^3.0.11",
|
|
40
|
+
"@smithy/invalid-dependency": "^3.0.11",
|
|
41
|
+
"@smithy/middleware-content-length": "^3.0.13",
|
|
42
|
+
"@smithy/middleware-endpoint": "^3.2.5",
|
|
43
|
+
"@smithy/middleware-retry": "^3.0.30",
|
|
44
|
+
"@smithy/middleware-serde": "^3.0.11",
|
|
45
|
+
"@smithy/middleware-stack": "^3.0.11",
|
|
46
|
+
"@smithy/node-config-provider": "^3.1.12",
|
|
47
|
+
"@smithy/node-http-handler": "^3.3.2",
|
|
48
|
+
"@smithy/protocol-http": "^4.1.8",
|
|
49
|
+
"@smithy/smithy-client": "^3.5.0",
|
|
50
|
+
"@smithy/types": "^3.7.2",
|
|
51
|
+
"@smithy/url-parser": "^3.0.11",
|
|
52
52
|
"@smithy/util-base64": "^3.0.0",
|
|
53
53
|
"@smithy/util-body-length-browser": "^3.0.0",
|
|
54
54
|
"@smithy/util-body-length-node": "^3.0.0",
|
|
55
|
-
"@smithy/util-defaults-mode-browser": "^3.0.
|
|
56
|
-
"@smithy/util-defaults-mode-node": "^3.0.
|
|
57
|
-
"@smithy/util-endpoints": "^2.1.
|
|
58
|
-
"@smithy/util-middleware": "^3.0.
|
|
59
|
-
"@smithy/util-retry": "^3.0.
|
|
55
|
+
"@smithy/util-defaults-mode-browser": "^3.0.30",
|
|
56
|
+
"@smithy/util-defaults-mode-node": "^3.0.30",
|
|
57
|
+
"@smithy/util-endpoints": "^2.1.7",
|
|
58
|
+
"@smithy/util-middleware": "^3.0.11",
|
|
59
|
+
"@smithy/util-retry": "^3.0.11",
|
|
60
60
|
"@smithy/util-utf8": "^3.0.0",
|
|
61
61
|
"@types/uuid": "^9.0.1",
|
|
62
62
|
"tslib": "^2.6.2",
|