@aws-sdk/client-kendra 3.299.0 → 3.301.0

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

@@ -30,6 +30,16 @@ export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEnt
  * import { KendraClient, AssociateEntitiesToExperienceCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, AssociateEntitiesToExperienceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = { // AssociateEntitiesToExperienceRequest
+ *   Id: "STRING_VALUE", // required
+ *   IndexId: "STRING_VALUE", // required
+ *   EntityList: [ // AssociateEntityList // required
+ *     { // EntityConfiguration
+ *       EntityId: "STRING_VALUE", // required
+ *       EntityType: "USER" || "GROUP", // required
+ *     },
+ *   ],
+ * };
  * const command = new AssociateEntitiesToExperienceCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -30,6 +30,16 @@ export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePerso
  * import { KendraClient, AssociatePersonasToEntitiesCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, AssociatePersonasToEntitiesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = { // AssociatePersonasToEntitiesRequest
+ *   Id: "STRING_VALUE", // required
+ *   IndexId: "STRING_VALUE", // required
+ *   Personas: [ // EntityPersonaConfigurationList // required
+ *     { // EntityPersonaConfiguration
+ *       EntityId: "STRING_VALUE", // required
+ *       Persona: "OWNER" || "VIEWER", // required
+ *     },
+ *   ],
+ * };
  * const command = new AssociatePersonasToEntitiesCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -30,6 +30,16 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
  * import { KendraClient, BatchDeleteDocumentCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, BatchDeleteDocumentCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = { // BatchDeleteDocumentRequest
+ *   IndexId: "STRING_VALUE", // required
+ *   DocumentIdList: [ // DocumentIdList // required
+ *     "STRING_VALUE",
+ *   ],
+ *   DataSourceSyncJobMetricTarget: { // DataSourceSyncJobMetricTarget
+ *     DataSourceId: "STRING_VALUE", // required
+ *     DataSourceSyncJobId: "STRING_VALUE",
+ *   },
+ * };
  * const command = new BatchDeleteDocumentCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -38,6 +38,27 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
  * import { KendraClient, BatchGetDocumentStatusCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, BatchGetDocumentStatusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = { // BatchGetDocumentStatusRequest
+ *   IndexId: "STRING_VALUE", // required
+ *   DocumentInfoList: [ // DocumentInfoList // required
+ *     { // DocumentInfo
+ *       DocumentId: "STRING_VALUE", // required
+ *       Attributes: [ // DocumentAttributeList
+ *         { // DocumentAttribute
+ *           Key: "STRING_VALUE", // required
+ *           Value: { // DocumentAttributeValue
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [ // DocumentAttributeStringListValue
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   ],
+ * };
  * const command = new BatchGetDocumentStatusCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -37,6 +37,120 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
  * import { KendraClient, BatchPutDocumentCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, BatchPutDocumentCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = { // BatchPutDocumentRequest
+ *   IndexId: "STRING_VALUE", // required
+ *   RoleArn: "STRING_VALUE",
+ *   Documents: [ // DocumentList // required
+ *     { // Document
+ *       Id: "STRING_VALUE", // required
+ *       Title: "STRING_VALUE",
+ *       Blob: "BLOB_VALUE",
+ *       S3Path: { // S3Path
+ *         Bucket: "STRING_VALUE", // required
+ *         Key: "STRING_VALUE", // required
+ *       },
+ *       Attributes: [ // DocumentAttributeList
+ *         { // DocumentAttribute
+ *           Key: "STRING_VALUE", // required
+ *           Value: { // DocumentAttributeValue
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [ // DocumentAttributeStringListValue
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *       ],
+ *       AccessControlList: [ // PrincipalList
+ *         { // Principal
+ *           Name: "STRING_VALUE", // required
+ *           Type: "USER" || "GROUP", // required
+ *           Access: "ALLOW" || "DENY", // required
+ *           DataSourceId: "STRING_VALUE",
+ *         },
+ *       ],
+ *       HierarchicalAccessControlList: [ // HierarchicalPrincipalList
+ *         { // HierarchicalPrincipal
+ *           PrincipalList: [ // required
+ *             {
+ *               Name: "STRING_VALUE", // required
+ *               Type: "USER" || "GROUP", // required
+ *               Access: "ALLOW" || "DENY", // required
+ *               DataSourceId: "STRING_VALUE",
+ *             },
+ *           ],
+ *         },
+ *       ],
+ *       ContentType: "PDF" || "HTML" || "MS_WORD" || "PLAIN_TEXT" || "PPT" || "RTF" || "XML" || "XSLT" || "MS_EXCEL" || "CSV" || "JSON" || "MD",
+ *       AccessControlConfigurationId: "STRING_VALUE",
+ *     },
+ *   ],
+ *   CustomDocumentEnrichmentConfiguration: { // CustomDocumentEnrichmentConfiguration
+ *     InlineConfigurations: [ // InlineCustomDocumentEnrichmentConfigurationList
+ *       { // InlineCustomDocumentEnrichmentConfiguration
+ *         Condition: { // DocumentAttributeCondition
+ *           ConditionDocumentAttributeKey: "STRING_VALUE", // required
+ *           Operator: "GreaterThan" || "GreaterThanOrEquals" || "LessThan" || "LessThanOrEquals" || "Equals" || "NotEquals" || "Contains" || "NotContains" || "Exists" || "NotExists" || "BeginsWith", // required
+ *           ConditionOnValue: {
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *         Target: { // DocumentAttributeTarget
+ *           TargetDocumentAttributeKey: "STRING_VALUE",
+ *           TargetDocumentAttributeValueDeletion: true || false,
+ *           TargetDocumentAttributeValue: {
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *         DocumentContentDeletion: true || false,
+ *       },
+ *     ],
+ *     PreExtractionHookConfiguration: { // HookConfiguration
+ *       InvocationCondition: {
+ *         ConditionDocumentAttributeKey: "STRING_VALUE", // required
+ *         Operator: "GreaterThan" || "GreaterThanOrEquals" || "LessThan" || "LessThanOrEquals" || "Equals" || "NotEquals" || "Contains" || "NotContains" || "Exists" || "NotExists" || "BeginsWith", // required
+ *         ConditionOnValue: {
+ *           StringValue: "STRING_VALUE",
+ *           StringListValue: [
+ *             "STRING_VALUE",
+ *           ],
+ *           LongValue: Number("long"),
+ *           DateValue: new Date("TIMESTAMP"),
+ *         },
+ *       },
+ *       LambdaArn: "STRING_VALUE", // required
+ *       S3Bucket: "STRING_VALUE", // required
+ *     },
+ *     PostExtractionHookConfiguration: {
+ *       InvocationCondition: {
+ *         ConditionDocumentAttributeKey: "STRING_VALUE", // required
+ *         Operator: "GreaterThan" || "GreaterThanOrEquals" || "LessThan" || "LessThanOrEquals" || "Equals" || "NotEquals" || "Contains" || "NotContains" || "Exists" || "NotExists" || "BeginsWith", // required
+ *         ConditionOnValue: {
+ *           StringValue: "STRING_VALUE",
+ *           StringListValue: [
+ *             "STRING_VALUE",
+ *           ],
+ *           LongValue: Number("long"),
+ *           DateValue: new Date("TIMESTAMP"),
+ *         },
+ *       },
+ *       LambdaArn: "STRING_VALUE", // required
+ *       S3Bucket: "STRING_VALUE", // required
+ *     },
+ *     RoleArn: "STRING_VALUE",
+ *   },
+ * };
  * const command = new BatchPutDocumentCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -35,6 +35,9 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
  * import { KendraClient, ClearQuerySuggestionsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, ClearQuerySuggestionsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = { // ClearQuerySuggestionsRequest
+ *   IndexId: "STRING_VALUE", // required
+ * };
  * const command = new ClearQuerySuggestionsCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -48,6 +48,32 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
  * import { KendraClient, CreateAccessControlConfigurationCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, CreateAccessControlConfigurationCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = { // CreateAccessControlConfigurationRequest
+ *   IndexId: "STRING_VALUE", // required
+ *   Name: "STRING_VALUE", // required
+ *   Description: "STRING_VALUE",
+ *   AccessControlList: [ // PrincipalList
+ *     { // Principal
+ *       Name: "STRING_VALUE", // required
+ *       Type: "USER" || "GROUP", // required
+ *       Access: "ALLOW" || "DENY", // required
+ *       DataSourceId: "STRING_VALUE",
+ *     },
+ *   ],
+ *   HierarchicalAccessControlList: [ // HierarchicalPrincipalList
+ *     { // HierarchicalPrincipal
+ *       PrincipalList: [ // required
+ *         {
+ *           Name: "STRING_VALUE", // required
+ *           Type: "USER" || "GROUP", // required
+ *           Access: "ALLOW" || "DENY", // required
+ *           DataSourceId: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *   ],
+ *   ClientToken: "STRING_VALUE",
+ * };
  * const command = new CreateAccessControlConfigurationCommand(input);
  * const response = await client.send(command);
  * ```