Skip to content

Commit 796599e

Browse files
author
awstools
committed
feat(client-kendra): This release adds GenAI Index in Amazon Kendra for Retrieval Augmented Generation (RAG) and intelligent search. With the Kendra GenAI Index, customers get high retrieval accuracy powered by the latest information retrieval technologies and semantic models.
1 parent 9616caf commit 796599e

21 files changed

+312
-161
lines changed

clients/client-kendra/src/commands/BatchDeleteDocumentCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
6060
* // FailedDocuments: [ // BatchDeleteDocumentResponseFailedDocuments
6161
* // { // BatchDeleteDocumentResponseFailedDocument
6262
* // Id: "STRING_VALUE",
63+
* // DataSourceId: "STRING_VALUE",
6364
* // ErrorCode: "InternalError" || "InvalidRequest",
6465
* // ErrorMessage: "STRING_VALUE",
6566
* // },

clients/client-kendra/src/commands/BatchGetDocumentStatusCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
7070
* // Errors: [ // BatchGetDocumentStatusResponseErrors
7171
* // { // BatchGetDocumentStatusResponseError
7272
* // DocumentId: "STRING_VALUE",
73+
* // DataSourceId: "STRING_VALUE",
7374
* // ErrorCode: "InternalError" || "InvalidRequest",
7475
* // ErrorMessage: "STRING_VALUE",
7576
* // },

clients/client-kendra/src/commands/BatchPutDocumentCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
167167
* // FailedDocuments: [ // BatchPutDocumentResponseFailedDocuments
168168
* // { // BatchPutDocumentResponseFailedDocument
169169
* // Id: "STRING_VALUE",
170+
* // DataSourceId: "STRING_VALUE",
170171
* // ErrorCode: "InternalError" || "InvalidRequest",
171172
* // ErrorMessage: "STRING_VALUE",
172173
* // },

clients/client-kendra/src/commands/CreateAccessControlConfigurationCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ export interface CreateAccessControlConfigurationCommandOutput
5252
* synchronize your data source. Amazon Kendra currently only supports access control
5353
* configuration for S3 data sources and documents indexed using the
5454
* <code>BatchPutDocument</code> API.</p>
55+
* <important>
56+
* <p>You can't configure access control using
57+
* <code>CreateAccessControlConfiguration</code> for an Amazon Kendra Gen AI Enterprise
58+
* Edition index. Amazon Kendra will return a <code>ValidationException</code> error for a
59+
* <code>Gen_AI_ENTERPRISE_EDITION</code> index.</p>
60+
* </important>
5561
* @example
5662
* Use a bare-bones client and the command you need to make an API call.
5763
* ```javascript

clients/client-kendra/src/commands/CreateIndexCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
4646
* const client = new KendraClient(config);
4747
* const input = { // CreateIndexRequest
4848
* Name: "STRING_VALUE", // required
49-
* Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
49+
* Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
5050
* RoleArn: "STRING_VALUE", // required
5151
* ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
5252
* KmsKeyId: "STRING_VALUE",

clients/client-kendra/src/commands/DeleteFaqCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteFaqCommandInput extends DeleteFaqRequest {}
2828
export interface DeleteFaqCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Removes an FAQ from an index.</p>
31+
* <p>Removes a FAQ from an index.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-kendra/src/commands/DeleteIndexCommand.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ export interface DeleteIndexCommandInput extends DeleteIndexRequest {}
2828
export interface DeleteIndexCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes an Amazon Kendra index. An exception is not thrown if the index is
32-
* already being deleted. While the index is being deleted, the <code>Status</code> field
33-
* returned by a call to the <code>DescribeIndex</code> API is set to
34-
* <code>DELETING</code>.</p>
31+
* <p>Deletes an Amazon Kendra index. An exception is not thrown if the index is already
32+
* being deleted. While the index is being deleted, the <code>Status</code> field returned by a
33+
* call to the <code>DescribeIndex</code> API is set to <code>DELETING</code>.</p>
3534
* @example
3635
* Use a bare-bones client and the command you need to make an API call.
3736
* ```javascript

clients/client-kendra/src/commands/DeletePrincipalMappingCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeletePrincipalMappingCommandInput extends DeletePrincipalMappi
2828
export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a group so that all users and sub groups that belong to the group can no
31+
* <p>Deletes a group so that all users that belong to the group can no
3232
* longer access documents only available to that group.</p>
3333
* <p>For example, after deleting the group "Summer Interns", all interns who belonged to
3434
* that group no longer see intern-only documents in their search results.</p>

clients/client-kendra/src/commands/DescribeFaqCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DescribeFaqCommandInput extends DescribeFaqRequest {}
2828
export interface DescribeFaqCommandOutput extends DescribeFaqResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets information about an FAQ list.</p>
31+
* <p>Gets information about a FAQ.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-kendra/src/commands/DescribeIndexCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met
4747
* // { // DescribeIndexResponse
4848
* // Name: "STRING_VALUE",
4949
* // Id: "STRING_VALUE",
50-
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
50+
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
5151
* // RoleArn: "STRING_VALUE",
5252
* // ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
5353
* // KmsKeyId: "STRING_VALUE",

clients/client-kendra/src/commands/ListFaqsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ListFaqsCommandInput extends ListFaqsRequest {}
2828
export interface ListFaqsCommandOutput extends ListFaqsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets a list of FAQ lists associated with an index.</p>
31+
* <p>Gets a list of FAQs associated with an index.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-kendra/src/commands/ListIndicesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface ListIndicesCommandOutput extends ListIndicesResponse, __Metadat
4646
* // { // IndexConfigurationSummary
4747
* // Name: "STRING_VALUE",
4848
* // Id: "STRING_VALUE",
49-
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
49+
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
5050
* // CreatedAt: new Date("TIMESTAMP"), // required
5151
* // UpdatedAt: new Date("TIMESTAMP"), // required
5252
* // Status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING" || "SYSTEM_UPDATING", // required

clients/client-kendra/src/commands/ListTagsForResourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
2828
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources
32-
* can have tags associated with them.</p>
31+
* <p>Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and
32+
* other resources can have tags associated with them.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

clients/client-kendra/src/commands/QueryCommand.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,13 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {}
5858
* results. If you filter result type to only question-answers, a maximum of four results are
5959
* returned. If you filter result type to only answers, a maximum of three results are
6060
* returned.</p>
61+
* <important>
62+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
63+
* <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If you're
64+
* using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
65+
* <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
66+
* <code>ValidationException</code> error.</p>
67+
* </important>
6168
* @example
6269
* Use a bare-bones client and the command you need to make an API call.
6370
* ```javascript

clients/client-kendra/src/commands/RetrieveCommand.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,13 @@ export interface RetrieveCommandOutput extends RetrieveResult, __MetadataBearer
6464
* units</a> that you set for your index. For more information on what's included
6565
* 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
6666
* capacity</a>.</p>
67+
* <important>
68+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
69+
* <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If
70+
* you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
71+
* <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
72+
* <code>ValidationException</code> error.</p>
73+
* </important>
6774
* @example
6875
* Use a bare-bones client and the command you need to make an API call.
6976
* ```javascript

clients/client-kendra/src/commands/TagResourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface TagResourceCommandInput extends TagResourceRequest {}
2828
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Adds the specified tag to the specified index, FAQ, or data source resource. If the tag
32-
* already exists, the existing value is replaced with the new value.</p>
31+
* <p>Adds the specified tag to the specified index, FAQ, data source, or other resource. If
32+
* the tag already exists, the existing value is replaced with the new value.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

clients/client-kendra/src/commands/UntagResourceCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {}
2828
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Removes a tag from an index, FAQ, or a data source.</p>
31+
* <p>Removes a tag from an index, FAQ, data source, or other resource.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-kendra/src/commands/UpdateAccessControlConfigurationCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ export interface UpdateAccessControlConfigurationCommandOutput
5252
* apply the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code>
5353
* file. Amazon Kendra currently only supports access control configuration for S3
5454
* data sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
55+
* <important>
56+
* <p>You can't configure access control using
57+
* <code>CreateAccessControlConfiguration</code> for an Amazon Kendra Gen AI Enterprise
58+
* Edition index. Amazon Kendra will return a <code>ValidationException</code> error for a
59+
* <code>Gen_AI_ENTERPRISE_EDITION</code> index.</p>
60+
* </important>
5561
* @example
5662
* Use a bare-bones client and the command you need to make an API call.
5763
* ```javascript

0 commit comments

Comments
 (0)