@aws-sdk/client-kendra 3.127.0 → 3.131.0

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

@@ -0,0 +1,54 @@
+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";
+export interface UpdateAccessControlConfigurationCommandInput extends UpdateAccessControlConfigurationRequest {
+}
+export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAccessControlConfigurationResponse, __MetadataBearer {
+}
+/**
+ * <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>
+ *             object. If you use an S3 bucket as a data source, you synchronize your data source to
+ *             apply the 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 command = new UpdateAccessControlConfigurationCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateAccessControlConfigurationCommandInput} for command's `input` shape.
+ * @see {@link UpdateAccessControlConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
+ *
+ */
+export declare class UpdateAccessControlConfigurationCommand extends $Command<UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
+    readonly input: UpdateAccessControlConfigurationCommandInput;
+    constructor(input: UpdateAccessControlConfigurationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -7,7 +7,7 @@ export interface UpdateThesaurusCommandInput extends UpdateThesaurusRequest {
 export interface UpdateThesaurusCommandOutput extends __MetadataBearer {
 }
 /**
- * <p>Updates a thesaurus file associated with an index.</p>
+ * <p>Updates a thesaurus for an index.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -4,12 +4,14 @@ export * from "./BatchDeleteDocumentCommand";
 export * from "./BatchGetDocumentStatusCommand";
 export * from "./BatchPutDocumentCommand";
 export * from "./ClearQuerySuggestionsCommand";
+export * from "./CreateAccessControlConfigurationCommand";
 export * from "./CreateDataSourceCommand";
 export * from "./CreateExperienceCommand";
 export * from "./CreateFaqCommand";
 export * from "./CreateIndexCommand";
 export * from "./CreateQuerySuggestionsBlockListCommand";
 export * from "./CreateThesaurusCommand";
+export * from "./DeleteAccessControlConfigurationCommand";
 export * from "./DeleteDataSourceCommand";
 export * from "./DeleteExperienceCommand";
 export * from "./DeleteFaqCommand";
@@ -17,6 +19,7 @@ export * from "./DeleteIndexCommand";
 export * from "./DeletePrincipalMappingCommand";
 export * from "./DeleteQuerySuggestionsBlockListCommand";
 export * from "./DeleteThesaurusCommand";
+export * from "./DescribeAccessControlConfigurationCommand";
 export * from "./DescribeDataSourceCommand";
 export * from "./DescribeExperienceCommand";
 export * from "./DescribeFaqCommand";
@@ -29,6 +32,7 @@ export * from "./DisassociateEntitiesFromExperienceCommand";
 export * from "./DisassociatePersonasFromEntitiesCommand";
 export * from "./GetQuerySuggestionsCommand";
 export * from "./GetSnapshotsCommand";
+export * from "./ListAccessControlConfigurationsCommand";
 export * from "./ListDataSourceSyncJobsCommand";
 export * from "./ListDataSourcesCommand";
 export * from "./ListEntityPersonasCommand";
@@ -47,6 +51,7 @@ export * from "./StopDataSourceSyncJobCommand";
 export * from "./SubmitFeedbackCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateAccessControlConfigurationCommand";
 export * from "./UpdateDataSourceCommand";
 export * from "./UpdateExperienceCommand";
 export * from "./UpdateIndexCommand";

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

@@ -1 +1,2 @@
 export * from "./models_0";
+export * from "./models_1";