@aws-sdk/client-kendra 3.696.0 → 3.706.0

package/dist-cjs/index.js

@@ -750,7 +750,8 @@ __name(_FeaturedResultsConflictException, "FeaturedResultsConflictException");
 var FeaturedResultsConflictException = _FeaturedResultsConflictException;
 var IndexEdition = {
   DEVELOPER_EDITION: "DEVELOPER_EDITION",
-  ENTERPRISE_EDITION: "ENTERPRISE_EDITION"
+  ENTERPRISE_EDITION: "ENTERPRISE_EDITION",
+  GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION"
 };
 var UserContextPolicy = {
   ATTRIBUTE_FILTER: "ATTRIBUTE_FILTER",

package/dist-es/models/models_0.js

@@ -353,6 +353,7 @@ export class FeaturedResultsConflictException extends __BaseException {
 export const IndexEdition = {
     DEVELOPER_EDITION: "DEVELOPER_EDITION",
     ENTERPRISE_EDITION: "ENTERPRISE_EDITION",
+    GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION",
 };
 export const UserContextPolicy = {
     ATTRIBUTE_FILTER: "ATTRIBUTE_FILTER",

package/dist-types/commands/BatchDeleteDocumentCommand.d.ts

@@ -59,6 +59,7 @@ declare const BatchDeleteDocumentCommand_base: {
  * //   FailedDocuments: [ // BatchDeleteDocumentResponseFailedDocuments
  * //     { // BatchDeleteDocumentResponseFailedDocument
  * //       Id: "STRING_VALUE",
+ * //       DataSourceId: "STRING_VALUE",
  * //       ErrorCode: "InternalError" || "InvalidRequest",
  * //       ErrorMessage: "STRING_VALUE",
  * //     },

package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts

@@ -69,6 +69,7 @@ declare const BatchGetDocumentStatusCommand_base: {
  * //   Errors: [ // BatchGetDocumentStatusResponseErrors
  * //     { // BatchGetDocumentStatusResponseError
  * //       DocumentId: "STRING_VALUE",
+ * //       DataSourceId: "STRING_VALUE",
  * //       ErrorCode: "InternalError" || "InvalidRequest",
  * //       ErrorMessage: "STRING_VALUE",
  * //     },

package/dist-types/commands/BatchPutDocumentCommand.d.ts

@@ -166,6 +166,7 @@ declare const BatchPutDocumentCommand_base: {
  * //   FailedDocuments: [ // BatchPutDocumentResponseFailedDocuments
  * //     { // BatchPutDocumentResponseFailedDocument
  * //       Id: "STRING_VALUE",
+ * //       DataSourceId: "STRING_VALUE",
  * //       ErrorCode: "InternalError" || "InvalidRequest",
  * //       ErrorMessage: "STRING_VALUE",
  * //     },

package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts

@@ -46,6 +46,12 @@ declare const CreateAccessControlConfigurationCommand_base: {
  *             synchronize your data source. Amazon Kendra currently only supports access control
  *             configuration for S3 data sources and documents indexed using the
  *                 <code>BatchPutDocument</code> API.</p>
+ *          <important>
+ *             <p>You can't configure access control using
+ *                     <code>CreateAccessControlConfiguration</code> for an Amazon Kendra Gen AI Enterprise
+ *                 Edition index. Amazon Kendra will return a <code>ValidationException</code> error for a
+ *                     <code>Gen_AI_ENTERPRISE_EDITION</code> index.</p>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/CreateIndexCommand.d.ts

@@ -45,7 +45,7 @@ declare const CreateIndexCommand_base: {
  * const client = new KendraClient(config);
  * const input = { // CreateIndexRequest
  *   Name: "STRING_VALUE", // required
- *   Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
+ *   Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
  *   RoleArn: "STRING_VALUE", // required
  *   ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
  *     KmsKeyId: "STRING_VALUE",

package/dist-types/commands/DeleteFaqCommand.d.ts

@@ -27,7 +27,7 @@ declare const DeleteFaqCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Removes an FAQ from an index.</p>
+ * <p>Removes a FAQ from an index.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DeleteIndexCommand.d.ts

@@ -27,10 +27,9 @@ declare const DeleteIndexCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes an Amazon Kendra index. An exception is not thrown if the index is
- *       already being deleted. While the index is being deleted, the <code>Status</code> field
- *       returned by a call to the <code>DescribeIndex</code> API is set to
- *       <code>DELETING</code>.</p>
+ * <p>Deletes an Amazon Kendra index. An exception is not thrown if the index is already
+ *       being deleted. While the index is being deleted, the <code>Status</code> field returned by a
+ *       call to the <code>DescribeIndex</code> API is set to <code>DELETING</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DeletePrincipalMappingCommand.d.ts

@@ -27,7 +27,7 @@ declare const DeletePrincipalMappingCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a group so that all users and sub groups that belong to the group can no
+ * <p>Deletes a group so that all users that belong to the group can no
  *             longer access documents only available to that group.</p>
  *          <p>For example, after deleting the group "Summer Interns", all interns who belonged to
  *             that group no longer see intern-only documents in their search results.</p>

package/dist-types/commands/DescribeFaqCommand.d.ts

@@ -27,7 +27,7 @@ declare const DescribeFaqCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Gets information about an FAQ list.</p>
+ * <p>Gets information about a FAQ.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DescribeIndexCommand.d.ts

@@ -42,7 +42,7 @@ declare const DescribeIndexCommand_base: {
  * // { // DescribeIndexResponse
  * //   Name: "STRING_VALUE",
  * //   Id: "STRING_VALUE",
- * //   Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
+ * //   Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
  * //   RoleArn: "STRING_VALUE",
  * //   ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
  * //     KmsKeyId: "STRING_VALUE",

package/dist-types/commands/ListFaqsCommand.d.ts

@@ -27,7 +27,7 @@ declare const ListFaqsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Gets a list of FAQ lists associated with an index.</p>
+ * <p>Gets a list of FAQs associated with an index.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListIndicesCommand.d.ts

@@ -45,7 +45,7 @@ declare const ListIndicesCommand_base: {
  * //     { // IndexConfigurationSummary
  * //       Name: "STRING_VALUE",
  * //       Id: "STRING_VALUE",
- * //       Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
+ * //       Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION" || "GEN_AI_ENTERPRISE_EDITION",
  * //       CreatedAt: new Date("TIMESTAMP"), // required
  * //       UpdatedAt: new Date("TIMESTAMP"), // required
  * //       Status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING" || "SYSTEM_UPDATING", // required

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -27,8 +27,8 @@ declare const ListTagsForResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources
- *       can have tags associated with them.</p>
+ * <p>Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and
+ *       other resources can have tags associated with them.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/QueryCommand.d.ts

@@ -57,6 +57,13 @@ declare const QueryCommand_base: {
  *          results. If you filter result type to only question-answers, a maximum of four results are
  *          returned. If you filter result type to only answers, a maximum of three results are
  *          returned.</p>
+ *          <important>
+ *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
+ *                <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If you're
+ *             using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
+ *                <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
+ *                <code>ValidationException</code> error.</p>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/RetrieveCommand.d.ts

@@ -63,6 +63,13 @@ declare const RetrieveCommand_base: {
  *                 units</a> that you set for your index. For more information on what's included
  *             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
  *                 capacity</a>.</p>
+ *          <important>
+ *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
+ *                     <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If
+ *                 you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
+ *                     <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
+ *                     <code>ValidationException</code> error.</p>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/TagResourceCommand.d.ts

@@ -27,8 +27,8 @@ declare const TagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Adds the specified tag to the specified index, FAQ, or data source resource. If the tag
- *       already exists, the existing value is replaced with the new value.</p>
+ * <p>Adds the specified tag to the specified index, FAQ, data source, or other resource. If
+ *       the tag already exists, the existing value is replaced with the new value.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -27,7 +27,7 @@ declare const UntagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Removes a tag from an index, FAQ, or a data source.</p>
+ * <p>Removes a tag from an index, FAQ, data source, or other resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts

@@ -46,6 +46,12 @@ declare const UpdateAccessControlConfigurationCommand_base: {
  *             apply the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code>
  *             file. Amazon Kendra currently only supports access control configuration for S3
  *             data sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
+ *          <important>
+ *             <p>You can't configure access control using
+ *                     <code>CreateAccessControlConfiguration</code> for an Amazon Kendra Gen AI Enterprise
+ *                 Edition index. Amazon Kendra will return a <code>ValidationException</code> error for a
+ *                     <code>Gen_AI_ENTERPRISE_EDITION</code> index.</p>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/models/models_0.d.ts

@@ -709,6 +709,16 @@ export interface DataSourceGroup {
  *             </li>
  *          </ul>
  *          <p>If you provide both, an exception is thrown.</p>
+ *          <important>
+ *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can use
+ *                <code>UserId</code>, <code>Groups</code>, and <code>DataSourceGroups</code> to filter
+ *             content. If you set the <code>UserId</code> to a particular user ID, it also includes
+ *             all public documents.</p>
+ *             <p>Amazon Kendra Gen AI Enterprise Edition indices don't support token based document filtering.
+ *             If you're using an Amazon Kendra Gen AI Enterprise Edition index, Amazon Kendra returns a
+ *                <code>ValidationException</code> error if the <code>Token</code> field has a non-null
+ *             value.</p>
+ *          </important>
  * @public
  */
 export interface UserContext {
@@ -790,7 +800,8 @@ export interface BasicAuthenticationConfiguration {
      */
     Port: number | undefined;
     /**
-     * <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
+     * <p>The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a
+     *             secret to store your credentials in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
      *          </p>
      *          <p>You use a secret if basic authentication credentials are required to connect to a
      *             website. The secret stores your credentials of user name and password.</p>
@@ -876,6 +887,11 @@ export interface BatchDeleteDocumentResponseFailedDocument {
      * @public
      */
     Id?: string | undefined;
+    /**
+     * <p> The identifier of the data source connector that the document belongs to. </p>
+     * @public
+     */
+    DataSourceId?: string | undefined;
     /**
      * <p>The error code for why the document couldn't be removed from the index.</p>
      * @public
@@ -1082,6 +1098,12 @@ export interface BatchGetDocumentStatusResponseError {
      * @public
      */
     DocumentId?: string | undefined;
+    /**
+     * <p> The identifier of the data source connector that the failed document belongs to.
+     *         </p>
+     * @public
+     */
+    DataSourceId?: string | undefined;
     /**
      * <p>Indicates the source of the error.</p>
      * @public
@@ -1261,8 +1283,8 @@ export interface HookConfiguration {
      */
     InvocationCondition?: DocumentAttributeCondition | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of a role with permission to run a Lambda function
-     *             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>
+     * <p>The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function
+     *             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>
      * @public
      */
     LambdaArn: string | undefined;
@@ -1304,10 +1326,10 @@ export interface CustomDocumentEnrichmentConfiguration {
      */
     PostExtractionHookConfiguration?: HookConfiguration | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of a role with permission to run
+     * <p>The Amazon Resource Name (ARN) of an IAM role with permission to run
      *                 <code>PreExtractionHookConfiguration</code> and
      *                 <code>PostExtractionHookConfiguration</code> for altering document metadata and
-     *             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>
+     *             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>
      * @public
      */
     RoleArn?: string | undefined;
@@ -1522,6 +1544,12 @@ export interface BatchPutDocumentResponseFailedDocument {
      * @public
      */
     Id?: string | undefined;
+    /**
+     * <p> The identifier of the data source connector that the failed document belongs to.
+     *         </p>
+     * @public
+     */
+    DataSourceId?: string | undefined;
     /**
      * <p>The type of error that caused the document to fail to be indexed.</p>
      * @public
@@ -1992,7 +2020,8 @@ export interface ProxyConfiguration {
      */
     Port: number | undefined;
     /**
-     * <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
+     * <p>The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a
+     *             secret to store your credentials in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
      *          </p>
      *          <p>The credentials are optional. You use a secret if web proxy credentials are required
      *             to connect to a website host. Amazon Kendra currently support basic authentication
@@ -2265,13 +2294,12 @@ export interface ConnectionConfiguration {
      */
     TableName: string | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. 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
+     * <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that stores
+     *             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
      *                 Database Data Source</a>. For more information about Secrets Manager, see
-     *                 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html"> What
-     *                 Is Secrets Manager</a> in the <i>
-     *                 Secrets Manager
-     *             </i> user guide.</p>
+     *             <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html"> What
+     *                 Is Secrets Manager</a> in the <i>Secrets Manager</i>
+     *             user guide.</p>
      * @public
      */
     SecretArn: string | undefined;
@@ -2986,7 +3014,7 @@ export interface OneDriveUsers {
     /**
      * <p>A list of users whose documents should be indexed. Specify the user names in email
      *             format, for example, <code>username@tenantdomain</code>. If you need to index the
-     *             documents of more than 100 users, use the <code>OneDriveUserS3Path</code> field to
+     *             documents of more than 10 users, use the <code>OneDriveUserS3Path</code> field to
      *             specify the location of a file containing a list of users.</p>
      * @public
      */
@@ -4553,15 +4581,15 @@ export interface DataSourceConfiguration {
     TemplateConfiguration?: TemplateConfiguration | undefined;
 }
 /**
- * <p>A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values
- *       can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : /
- *       = + - @.</p>
+ * <p>A key-value pair that identifies or categorizes an index, FAQ,
+ *       data source, or other resource. TA tag key and value can consist of Unicode letters,
+ *       digits, white space, and any of the following symbols: _ . : / = + - @.</p>
  * @public
  */
 export interface Tag {
     /**
-     * <p>The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or
-     *       data source.</p>
+     * <p>The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ,
+     *       data source, or other resource.</p>
      * @public
      */
     Key: string | undefined;
@@ -4860,7 +4888,7 @@ export interface CreateFaqRequest {
     S3Path: S3Path | undefined;
     /**
      * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
-     *             the S3 bucket that contains the FAQs. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for
+     *             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
      *                 Amazon Kendra</a>.</p>
      * @public
      */
@@ -5141,6 +5169,7 @@ export declare class FeaturedResultsConflictException extends __BaseException {
 export declare const IndexEdition: {
     readonly DEVELOPER_EDITION: "DEVELOPER_EDITION";
     readonly ENTERPRISE_EDITION: "ENTERPRISE_EDITION";
+    readonly GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION";
 };
 /**
  * @public
@@ -5185,12 +5214,10 @@ export declare const UserGroupResolutionMode: {
  */
 export type UserGroupResolutionMode = (typeof UserGroupResolutionMode)[keyof typeof UserGroupResolutionMode];
 /**
- * <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 results are filtered based on the user or their group access to documents. You can
- *          also use 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 provide the user ID when you issue the
- *          query.</p>
+ * <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
+ *          results are filtered based on the user or their group access to documents. You can also use
+ *          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
+ *          provide the user ID when you issue the query.</p>
  *          <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
  *          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>
  *          <p>Amazon Kendra currently does not support using
@@ -5198,13 +5225,16 @@ export type UserGroupResolutionMode = (typeof UserGroupResolutionMode)[keyof typ
  *          member account for your IAM Identity Center identify source. You must create your index in
  *          the management account for the organization in order to use
  *             <code>UserGroupResolutionConfiguration</code>.</p>
+ *          <important>
+ *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index,
+ *                <code>UserGroupResolutionConfiguration</code> isn't supported.</p>
+ *          </important>
  * @public
  */
 export interface UserGroupResolutionConfiguration {
     /**
-     * <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 an IAM Identity Center identity source in order to use this mode.</p>
+     * <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
+     *          an IAM Identity Center identity source in order to use this mode.</p>
      * @public
      */
     UserGroupResolutionMode: UserGroupResolutionMode | undefined;
@@ -5280,6 +5310,11 @@ export interface JwtTokenTypeConfiguration {
 }
 /**
  * <p>Provides the configuration information for a token.</p>
+ *          <important>
+ *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
+ *                <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns
+ *             a <code>ValidationException</code> error.</p>
+ *          </important>
  * @public
  */
 export interface UserTokenConfiguration {
@@ -5306,18 +5341,20 @@ export interface CreateIndexRequest {
     /**
      * <p>The Amazon Kendra edition to use for the index. Choose <code>DEVELOPER_EDITION</code>
      *       for indexes intended for development, testing, or proof of concept. Use
-     *         <code>ENTERPRISE_EDITION</code> for production. Once you set the edition for
-     *       an index, it can't be changed.</p>
+     *         <code>ENTERPRISE_EDITION</code> for production. Use <code>GEN_AI_ENTERPRISE_EDITION</code>
+     *       for creating generative AI applications. Once you set the edition for an index, it can't be
+     *       changed. </p>
      *          <p>The <code>Edition</code> parameter is optional. If you don't supply a value, the default
      *       is <code>ENTERPRISE_EDITION</code>.</p>
-     *          <p>For more information on quota limits for Enterprise and Developer editions, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</p>
+     *          <p>For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and
+     *       Developer Edition indices, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</p>
      * @public
      */
     Edition?: IndexEdition | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access 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 for
-     *       Amazon Kendra</a>.</p>
+     * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
+     *       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
+     *         for Amazon Kendra</a>.</p>
      * @public
      */
     RoleArn: string | undefined;
@@ -5347,11 +5384,23 @@ export interface CreateIndexRequest {
     Tags?: Tag[] | undefined;
     /**
      * <p>The user token configuration.</p>
+     *          <important>
+     *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
+     *                <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns
+     *             a <code>ValidationException</code> error.</p>
+     *          </important>
      * @public
      */
     UserTokenConfigurations?: UserTokenConfiguration[] | undefined;
     /**
      * <p>The user context policy.</p>
+     *          <important>
+     *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
+     *                <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If you're
+     *             using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
+     *                <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
+     *                <code>ValidationException</code> error.</p>
+     *          </important>
      *          <dl>
      *             <dt>ATTRIBUTE_FILTER</dt>
      *             <dd>
@@ -5371,9 +5420,14 @@ export interface CreateIndexRequest {
      */
     UserContextPolicy?: UserContextPolicy | undefined;
     /**
-     * <p>Gets users and groups from IAM Identity Center
-     *          identity source. To configure this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering, where
-     *          search results are filtered based on the user or their group access to documents.</p>
+     * <p>Gets users and groups from IAM Identity Center identity source. To configure this,
+     *          see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering,
+     *          where search results are filtered based on the user or their group access to
+     *          documents.</p>
+     *          <important>
+     *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index,
+     *                <code>UserGroupResolutionConfiguration</code> isn't supported.</p>
+     *          </important>
      * @public
      */
     UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined;
@@ -5812,8 +5866,8 @@ export interface DescribeDataSourceResponse {
      */
     Schedule?: string | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of the role with permission to access the data source and
-     *       required resources.</p>
+     * <p>The Amazon Resource Name (ARN) of the IAM role with permission to
+     *       access the data source and required resources.</p>
      * @public
      */
     RoleArn?: string | undefined;
@@ -5958,10 +6012,10 @@ export interface DescribeExperienceResponse {
      */
     Status?: ExperienceStatus | undefined;
     /**
-     * <p>Shows the Amazon Resource Name (ARN) of a role with permission to access
-     *             <code>Query</code> API, <code>QuerySuggestions</code> API,
+     * <p>The Amazon Resource Name (ARN) of the IAM role with permission to access
+     *             the <code>Query</code> API, <code>QuerySuggestions</code> API,
      *             <code>SubmitFeedback</code> API, and IAM Identity Center that stores
-     *             your user and group information.</p>
+     *             your users and groups information.</p>
      * @public
      */
     RoleArn?: string | undefined;
@@ -6047,8 +6101,8 @@ export interface DescribeFaqResponse {
      */
     Status?: FaqStatus | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket
-     *             containing the input files for the FAQ.</p>
+     * <p>The Amazon Resource Name (ARN) of the IAM role that provides access
+     *             to the S3 bucket containing the FAQ file.</p>
      * @public
      */
     RoleArn?: string | undefined;
@@ -6059,7 +6113,7 @@ export interface DescribeFaqResponse {
      */
     ErrorMessage?: string | undefined;
     /**
-     * <p>The file format used by the input files for the FAQ.</p>
+     * <p>The file format used for the FAQ file.</p>
      * @public
      */
     FileFormat?: FaqFileFormat | undefined;
@@ -6377,13 +6431,13 @@ export interface DocumentMetadataConfiguration {
     Search?: Search | undefined;
 }
 /**
- * <p>Provides statistical information about the FAQ questions and answers contained in an
+ * <p>Provides statistical information about the FAQ questions and answers for an
  *             index.</p>
  * @public
  */
 export interface FaqStatistics {
     /**
-     * <p>The total number of FAQ questions and answers contained in the index.</p>
+     * <p>The total number of FAQ questions and answers for an index.</p>
      * @public
      */
     IndexedQuestionAnswersCount: number | undefined;
@@ -6458,8 +6512,7 @@ export interface DescribeIndexResponse {
      */
     Edition?: IndexEdition | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of the IAM role that gives
-     *       Amazon Kendra permission to write to your Amazon CloudWatch logs.</p>
+     * <p>The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.</p>
      * @public
      */
     RoleArn?: string | undefined;
@@ -6530,9 +6583,9 @@ export interface DescribeIndexResponse {
      */
     UserContextPolicy?: UserContextPolicy | undefined;
     /**
-     * <p>Whether you have enabled IAM Identity Center identity source for your
-     *          users and groups. This is useful for user context filtering, where
-     *          search results are filtered based on the user or their group access to documents.</p>
+     * <p>Whether you have enabled IAM Identity Center identity source for your users and
+     *          groups. This is useful for user context filtering, where search results are filtered based
+     *          on the user or their group access to documents.</p>
      * @public
      */
     UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined;
@@ -7882,7 +7935,7 @@ export interface ListExperiencesResponse {
  */
 export interface ListFaqsRequest {
     /**
-     * <p>The index that contains the FAQ lists.</p>
+     * <p>The index for the FAQs.</p>
      * @public
      */
     IndexId: string | undefined;
@@ -7958,7 +8011,7 @@ export interface ListFaqsResponse {
      */
     NextToken?: string | undefined;
     /**
-     * <p>information about the FAQs associated with the specified index.</p>
+     * <p>Summary information about the FAQs for a specified index.</p>
      * @public
      */
     FaqSummaryItems?: FaqSummary[] | undefined;
@@ -8279,8 +8332,12 @@ export interface ListQuerySuggestionsBlockListsResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
-     * <p>The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags
-     *       for.</p>
+     * <p>The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to
+     *       get a list of tags for. For example, the ARN of an index is constructed as follows:
+     *       <i>arn:aws:kendra:your-region:your-account-id:index/index-id</i>
+     *       For information on how to construct an ARN for all types of Amazon Kendra resources, see
+     *       <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies">Resource
+     *         types</a>.</p>
      * @public
      */
     ResourceARN: string | undefined;
@@ -8290,7 +8347,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
-     * <p>A list of tags associated with the index, FAQ, or data source.</p>
+     * <p>A list of tags associated with the index, FAQ, data source, or other resource.</p>
      * @public
      */
     Tags?: Tag[] | undefined;
@@ -8409,15 +8466,16 @@ export interface MemberUser {
     UserId: string | undefined;
 }
 /**
- * <p>A list of users or sub groups that belong to a group. This is useful for user context
+ * <p>A list of users that belong to a group. This is useful for user context
  *             filtering, where search results are filtered based on the user or their group access to
  *             documents.</p>
  * @public
  */
 export interface GroupMembers {
     /**
-     * <p>A list of sub groups that belong to a group. For example, the sub groups "Research",
-     *             "Engineering", and "Sales and Marketing" all belong to the group "Company".</p>
+     * <p>A list of users that belong to a group. This can also include sub groups. For example,
+     *             the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group
+     *             "Company A".</p>
      * @public
      */
     MemberGroups?: MemberGroup[] | undefined;
@@ -8465,8 +8523,9 @@ export interface PutPrincipalMappingRequest {
      */
     GroupId: string | undefined;
     /**
-     * <p>The list that contains your users or sub groups that belong the same group.</p>
-     *          <p>For example, the group "Company" includes the user "CEO" and the sub groups
+     * <p>The list that contains your users that belong the same group. This can include sub groups
+     *             that belong to a group.</p>
+     *          <p>For example, the group "Company A" includes the user "CEO" and the sub groups
      *             "Research", "Engineering", and "Sales and Marketing".</p>
      *          <p>If you have more than 1000 users and/or sub groups for a single group, you need to
      *             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 {
      */
     GroupMembers: GroupMembers | undefined;
     /**
-     * <p>The timestamp identifier you specify to ensure Amazon Kendra does not override
+     * <p>The timestamp identifier you specify to ensure Amazon Kendra doesn't override
      *             the latest <code>PUT</code> action with previous actions. The highest number ID, which
      *             is the ordering ID, is the latest action you want to process and apply on top of other
      *             actions with lower number IDs. This prevents previous actions with lower number IDs from
@@ -8492,9 +8551,10 @@ export interface PutPrincipalMappingRequest {
      */
     OrderingId?: number | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains
-     *             your list of users or sub groups that belong to a group.</p>
-     *          <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds">IAM roles for Amazon Kendra</a>.</p>
+     * <p>The Amazon Resource Name (ARN) of an IAM role that has access to the
+     *             S3 file that contains your list of users that belong to a group.</p>
+     *          <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds">IAM roles for
+     *             Amazon Kendra</a>.</p>
      * @public
      */
     RoleArn?: string | undefined;

package/dist-types/models/models_1.d.ts

@@ -454,13 +454,18 @@ export interface SubmitFeedbackRequest {
  */
 export interface TagResourceRequest {
     /**
-     * <p>The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.</p>
+     * <p>The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to add a tag.
+     *       For example, the ARN of an index is constructed as follows:
+     *       <i>arn:aws:kendra:your-region:your-account-id:index/index-id</i>
+     *       For information on how to construct an ARN for all types of Amazon Kendra resources, see
+     *       <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies">Resource
+     *         types</a>.</p>
      * @public
      */
     ResourceARN: string | undefined;
     /**
-     * <p>A list of tag keys to add to the index, FAQ, or data source. If a tag already exists, the
-     *       existing value is replaced with the new value.</p>
+     * <p>A list of tag keys to add to the index, FAQ, data source, or other resource. If a tag already
+     *       exists, the existing value is replaced with the new value.</p>
      * @public
      */
     Tags: Tag[] | undefined;
@@ -475,14 +480,18 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
-     * <p>The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag
-     *       from.</p>
+     * <p>The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to remove a tag.
+     *       For example, the ARN of an index is constructed as follows:
+     *       <i>arn:aws:kendra:your-region:your-account-id:index/index-id</i>
+     *       For information on how to construct an ARN for all types of Amazon Kendra resources, see
+     *       <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies">Resource
+     *         types</a>.</p>
      * @public
      */
     ResourceARN: string | undefined;
     /**
-     * <p>A list of tag keys to remove from the index, FAQ, or data source. If a tag key does not
-     *       exist on the resource, it is ignored.</p>
+     * <p>A list of tag keys to remove from the index, FAQ, data source, or other resource. If a tag
+     *       key doesn't exist for the resource, it is ignored.</p>
      * @public
      */
     TagKeys: string[] | undefined;
@@ -576,8 +585,8 @@ export interface UpdateDataSourceRequest {
      */
     Schedule?: string | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of a role with permission to access 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>
+     * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
+     *       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>
      * @public
      */
     RoleArn?: string | undefined;
@@ -620,9 +629,9 @@ export interface UpdateExperienceRequest {
      */
     IndexId: string | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
-     *             API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
-     *             API, and IAM Identity Center that stores your user and group information.
+     * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
+     *             the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
+     *             API, and IAM Identity Center that stores your users and groups information.
      *             For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
      * @public
      */
@@ -741,18 +750,35 @@ export interface UpdateIndexRequest {
     CapacityUnits?: CapacityUnitsConfiguration | undefined;
     /**
      * <p>The user token configuration.</p>
+     *          <important>
+     *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
+     *                <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns
+     *             a <code>ValidationException</code> error.</p>
+     *          </important>
      * @public
      */
     UserTokenConfigurations?: UserTokenConfiguration[] | undefined;
     /**
      * <p>The user context policy.</p>
+     *          <important>
+     *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
+     *                <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If you're
+     *             using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
+     *                <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
+     *                <code>ValidationException</code> error.</p>
+     *          </important>
      * @public
      */
     UserContextPolicy?: UserContextPolicy | undefined;
     /**
-     * <p>Gets users and groups from IAM Identity Center
-     *          identity source. To configure this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering, where
-     *          search results are filtered based on the user or their group access to documents.</p>
+     * <p>Gets users and groups from IAM Identity Center identity source. To configure this,
+     *          see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering,
+     *          where search results are filtered based on the user or their group access to
+     *          documents.</p>
+     *          <important>
+     *             <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index,
+     *                <code>UserGroupResolutionConfiguration</code> isn't supported.</p>
+     *          </important>
      * @public
      */
     UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined;
@@ -1007,7 +1033,7 @@ export interface FacetResult {
  *          "Department", you can filter documents that belong to the "HR" department. You would use
  *          the <code>EqualsTo</code> operation to filter results or documents with "Department" equals
  *          to "HR".</p>
- *          <p>You can use <code>AndAllFilters</code> and <code>AndOrFilters</code> in combination with
+ *          <p>You can use <code>AndAllFilters</code> and <code>OrAllFilters</code> in combination with
  *          each other or with other operations such as <code>EqualsTo</code>. For example:</p>
  *          <p>
  *             <code>AndAllFilters</code>
@@ -1019,7 +1045,7 @@ export interface FacetResult {
  *             </li>
  *             <li>
  *                <p>
- *                   <code>AndOrFilters</code>
+ *                   <code>OrAllFilters</code>
  *                </p>
  *                <ul>
  *                   <li>
@@ -1030,8 +1056,8 @@ export interface FacetResult {
  *             </li>
  *          </ul>
  *          <p>This example filters results or documents that belong to the HR department
- *             <i>and</i> belong to projects that contain "new hires"
- *             <i>or</i> "new hiring" in the project name (must use
+ *             <code>AND</code> belong to projects that contain "new hires"
+ *             <code>OR</code> "new hiring" in the project name (must use
  *             <code>ContainAny</code> with <code>StringListValue</code>). This example is filtering
  *          with a depth of 2.</p>
  *          <p>You cannot filter more than a depth of 2, otherwise you receive a
@@ -1217,6 +1243,11 @@ export interface RetrieveRequest {
      *                 <code>OrAllFilters</code> parameters contain a list of other filters.</p>
      *          <p>The <code>AttributeFilter</code> parameter means you can create a set of filtering
      *             rules that a document must satisfy to be included in the query results.</p>
+     *          <note>
+     *             <p>For Amazon Kendra Gen AI Enterprise Edition indices use <code>AttributeFilter</code> to
+     *                 enable document filtering for end users using <code>_email_id</code> or include
+     *                 public documents (<code>_email_id=null</code>).</p>
+     *          </note>
      * @public
      */
     AttributeFilter?: AttributeFilter | undefined;
@@ -1329,6 +1360,11 @@ export interface QueryRequest {
      *             <code>OrAllFilters</code> parameters contain a list of other filters.</p>
      *          <p>The <code>AttributeFilter</code> parameter means you can create a set of filtering rules
      *          that a document must satisfy to be included in the query results.</p>
+     *          <note>
+     *             <p>For Amazon Kendra Gen AI Enterprise Edition indices use <code>AttributeFilter</code> to
+     *             enable document filtering for end users using <code>_email_id</code> or include public
+     *             documents (<code>_email_id=null</code>).</p>
+     *          </note>
      * @public
      */
     AttributeFilter?: AttributeFilter | undefined;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -221,6 +221,7 @@ export declare const ErrorCode: {
 export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
 export interface BatchDeleteDocumentResponseFailedDocument {
   Id?: string | undefined;
+  DataSourceId?: string | undefined;
   ErrorCode?: ErrorCode | undefined;
   ErrorMessage?: string | undefined;
 }
@@ -271,6 +272,7 @@ export interface Status {
 }
 export interface BatchGetDocumentStatusResponseError {
   DocumentId?: string | undefined;
+  DataSourceId?: string | undefined;
   ErrorCode?: ErrorCode | undefined;
   ErrorMessage?: string | undefined;
 }
@@ -377,6 +379,7 @@ export interface BatchPutDocumentRequest {
 }
 export interface BatchPutDocumentResponseFailedDocument {
   Id?: string | undefined;
+  DataSourceId?: string | undefined;
   ErrorCode?: ErrorCode | undefined;
   ErrorMessage?: string | undefined;
 }
@@ -1111,6 +1114,7 @@ export declare class FeaturedResultsConflictException extends __BaseException {
 export declare const IndexEdition: {
   readonly DEVELOPER_EDITION: "DEVELOPER_EDITION";
   readonly ENTERPRISE_EDITION: "ENTERPRISE_EDITION";
+  readonly GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION";
 };
 export type IndexEdition = (typeof IndexEdition)[keyof typeof IndexEdition];
 export interface ServerSideEncryptionConfiguration {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-kendra",
   "description": "AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native",
-  "version": "3.696.0",
+  "version": "3.706.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-kendra",
@@ -20,10 +20,10 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.696.0",
-    "@aws-sdk/client-sts": "3.696.0",
+    "@aws-sdk/client-sso-oidc": "3.699.0",
+    "@aws-sdk/client-sts": "3.699.0",
     "@aws-sdk/core": "3.696.0",
-    "@aws-sdk/credential-provider-node": "3.696.0",
+    "@aws-sdk/credential-provider-node": "3.699.0",
     "@aws-sdk/middleware-host-header": "3.696.0",
     "@aws-sdk/middleware-logger": "3.696.0",
     "@aws-sdk/middleware-recursion-detection": "3.696.0",