@aws-sdk/client-kendra 3.300.0 → 3.303.0

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

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
 import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
-import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
+import { TagResourceRequest, TagResourceResponse } from "../models/models_1";
 /**
  * @public
  *
@@ -19,19 +19,18 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 }
 /**
  * @public
- * <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, or data source 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
  * import { KendraClient, TagResourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, TagResourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
- * const input = {
+ * const input = { // TagResourceRequest
  *   ResourceARN: "STRING_VALUE", // required
- *   Tags: [ // required
- *     {
+ *   Tags: [ // TagList // required
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE", // required
  *     },
@@ -53,7 +52,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
- *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceUnavailableException} (client fault)
  *  <p>The resource you want to use isn't available. Please check you have provided the

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

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
 import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
-import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
+import { UntagResourceRequest, UntagResourceResponse } from "../models/models_1";
 /**
  * @public
  *
@@ -26,9 +26,9 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * import { KendraClient, UntagResourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, UntagResourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
- * const input = {
+ * const input = { // UntagResourceRequest
  *   ResourceARN: "STRING_VALUE", // required
- *   TagKeys: [ // required
+ *   TagKeys: [ // TagKeyList // required
  *     "STRING_VALUE",
  *   ],
  * };
@@ -48,7 +48,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
- *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceUnavailableException} (client fault)
  *  <p>The resource you want to use isn't available. Please check you have provided the

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

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
 import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
-import { UpdateAccessControlConfigurationRequest, UpdateAccessControlConfigurationResponse } from "../models/models_0";
+import { UpdateAccessControlConfigurationRequest, UpdateAccessControlConfigurationResponse } from "../models/models_1";
 /**
  * @public
  *
@@ -19,47 +19,46 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
 }
 /**
  * @public
- * <p>Updates an access control configuration for your documents in an index. This
- *             includes user and group access information for your documents. This is useful
- *             for user context filtering, where search results are filtered based on the user
- *             or their group access to documents.</p>
- *          <p>You can update an access control configuration you created without indexing all
- *             of your documents again. For example, your index contains top-secret company
- *             documents that only certain employees or users should access. You created an 'allow'
- *             access control configuration for one user who recently joined the 'top-secret' team,
- *             switching from a team with 'deny' access to top-secret documents. However, the user
- *             suddenly returns to their previous team and should no longer have access to top secret
- *             documents. You can update the access control configuration to re-configure access
- *             control for your documents as circumstances change.</p>
+ * <p>Updates an access control configuration for your documents in an index. This includes
+ *             user and group access information for your documents. This is useful for user context
+ *             filtering, where search results are filtered based on the user or their group access to
+ *             documents.</p>
+ *          <p>You can update an access control configuration you created without indexing all of
+ *             your documents again. For example, your index contains top-secret company documents that
+ *             only certain employees or users should access. You created an 'allow' access control
+ *             configuration for one user who recently joined the 'top-secret' team, switching from a
+ *             team with 'deny' access to top-secret documents. However, the user suddenly returns to
+ *             their previous team and should no longer have access to top secret documents. You can
+ *             update the access control configuration to re-configure access control for your
+ *             documents as circumstances change.</p>
  *          <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to
  *             apply the updated access control configuration, with the
- *                 <code>AccessControlConfigurationId</code> included in the
- *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
+ *                 <code>AccessControlConfigurationId</code> included in the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
  *             object. If you use an S3 bucket as a data source, you synchronize your data source to
- *             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>
+ *             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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
  * import { KendraClient, UpdateAccessControlConfigurationCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, UpdateAccessControlConfigurationCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
- * const input = {
+ * const input = { // UpdateAccessControlConfigurationRequest
  *   IndexId: "STRING_VALUE", // required
  *   Id: "STRING_VALUE", // required
  *   Name: "STRING_VALUE",
  *   Description: "STRING_VALUE",
- *   AccessControlList: [
- *     {
+ *   AccessControlList: [ // PrincipalList
+ *     { // Principal
  *       Name: "STRING_VALUE", // required
  *       Type: "USER" || "GROUP", // required
  *       Access: "ALLOW" || "DENY", // required
  *       DataSourceId: "STRING_VALUE",
  *     },
  *   ],
- *   HierarchicalAccessControlList: [
- *     {
+ *   HierarchicalAccessControlList: [ // HierarchicalPrincipalList
+ *     { // HierarchicalPrincipal
  *       PrincipalList: [ // required
  *         {
  *           Name: "STRING_VALUE", // required
@@ -91,7 +90,7 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
- *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -99,7 +98,8 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>You have exceeded the set limits for your Amazon Kendra service. Please see
- *             Quotas[hyperlink Kendra Quotas pg] for more information, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> to inquire about
+ *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
+ *             more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
  *             an increase of limits.</p>
  *
  * @throws {@link ThrottlingException} (client fault)