@aws-sdk/client-kendra 3.298.0 → 3.300.0

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

@@ -46,6 +46,270 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
  * import { KendraClient, QueryCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, QueryCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = {
+ *   IndexId: "STRING_VALUE", // required
+ *   QueryText: "STRING_VALUE",
+ *   AttributeFilter: {
+ *     AndAllFilters: [
+ *       {
+ *         AndAllFilters: [
+ *           {
+ *             AndAllFilters: "<AttributeFilter>",
+ *             OrAllFilters: [
+ *               "<AttributeFilterList>",
+ *             ],
+ *             NotFilter: {
+ *               AndAllFilters: "<AttributeFilter>",
+ *               OrAllFilters: [
+ *                 "<AttributeFilterList>",
+ *               ],
+ *               NotFilter: {
+ *                 AndAllFilters: "<AttributeFilter>",
+ *                 OrAllFilters: "<AttributeFilter>",
+ *                 NotFilter: "<AttributeFilter>",
+ *                 EqualsTo: {
+ *                   Key: "STRING_VALUE", // required
+ *                   Value: {
+ *                     StringValue: "STRING_VALUE",
+ *                     StringListValue: [
+ *                       "STRING_VALUE",
+ *                     ],
+ *                     LongValue: Number("long"),
+ *                     DateValue: new Date("TIMESTAMP"),
+ *                   },
+ *                 },
+ *                 ContainsAll: {
+ *                   Key: "STRING_VALUE", // required
+ *                   Value: {
+ *                     StringValue: "STRING_VALUE",
+ *                     StringListValue: [
+ *                       "STRING_VALUE",
+ *                     ],
+ *                     LongValue: Number("long"),
+ *                     DateValue: new Date("TIMESTAMP"),
+ *                   },
+ *                 },
+ *                 ContainsAny: {
+ *                   Key: "STRING_VALUE", // required
+ *                   Value: {
+ *                     StringValue: "STRING_VALUE",
+ *                     StringListValue: [
+ *                       "STRING_VALUE",
+ *                     ],
+ *                     LongValue: Number("long"),
+ *                     DateValue: new Date("TIMESTAMP"),
+ *                   },
+ *                 },
+ *                 GreaterThan: {
+ *                   Key: "STRING_VALUE", // required
+ *                   Value: {
+ *                     StringValue: "STRING_VALUE",
+ *                     StringListValue: [
+ *                       "STRING_VALUE",
+ *                     ],
+ *                     LongValue: Number("long"),
+ *                     DateValue: new Date("TIMESTAMP"),
+ *                   },
+ *                 },
+ *                 GreaterThanOrEquals: {
+ *                   Key: "STRING_VALUE", // required
+ *                   Value: {
+ *                     StringValue: "STRING_VALUE",
+ *                     StringListValue: [
+ *                       "STRING_VALUE",
+ *                     ],
+ *                     LongValue: Number("long"),
+ *                     DateValue: new Date("TIMESTAMP"),
+ *                   },
+ *                 },
+ *                 LessThan: {
+ *                   Key: "STRING_VALUE", // required
+ *                   Value: {
+ *                     StringValue: "STRING_VALUE",
+ *                     StringListValue: [
+ *                       "STRING_VALUE",
+ *                     ],
+ *                     LongValue: Number("long"),
+ *                     DateValue: new Date("TIMESTAMP"),
+ *                   },
+ *                 },
+ *                 LessThanOrEquals: {
+ *                   Key: "STRING_VALUE", // required
+ *                   Value: {
+ *                     StringValue: "STRING_VALUE",
+ *                     StringListValue: [
+ *                       "STRING_VALUE",
+ *                     ],
+ *                     LongValue: Number("long"),
+ *                     DateValue: new Date("TIMESTAMP"),
+ *                   },
+ *                 },
+ *               },
+ *               EqualsTo: {
+ *                 Key: "STRING_VALUE", // required
+ *                 Value: {
+ *                   StringValue: "STRING_VALUE",
+ *                   StringListValue: [
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   LongValue: Number("long"),
+ *                   DateValue: new Date("TIMESTAMP"),
+ *                 },
+ *               },
+ *               ContainsAll: {
+ *                 Key: "STRING_VALUE", // required
+ *                 Value: {
+ *                   StringValue: "STRING_VALUE",
+ *                   StringListValue: [
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   LongValue: Number("long"),
+ *                   DateValue: new Date("TIMESTAMP"),
+ *                 },
+ *               },
+ *               ContainsAny: {
+ *                 Key: "STRING_VALUE", // required
+ *                 Value: {
+ *                   StringValue: "STRING_VALUE",
+ *                   StringListValue: [
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   LongValue: Number("long"),
+ *                   DateValue: new Date("TIMESTAMP"),
+ *                 },
+ *               },
+ *               GreaterThan: {
+ *                 Key: "STRING_VALUE", // required
+ *                 Value: {
+ *                   StringValue: "STRING_VALUE",
+ *                   StringListValue: [
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   LongValue: Number("long"),
+ *                   DateValue: new Date("TIMESTAMP"),
+ *                 },
+ *               },
+ *               GreaterThanOrEquals: {
+ *                 Key: "STRING_VALUE", // required
+ *                 Value: {
+ *                   StringValue: "STRING_VALUE",
+ *                   StringListValue: [
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   LongValue: Number("long"),
+ *                   DateValue: new Date("TIMESTAMP"),
+ *                 },
+ *               },
+ *               LessThan: {
+ *                 Key: "STRING_VALUE", // required
+ *                 Value: {
+ *                   StringValue: "STRING_VALUE",
+ *                   StringListValue: [
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   LongValue: Number("long"),
+ *                   DateValue: new Date("TIMESTAMP"),
+ *                 },
+ *               },
+ *               LessThanOrEquals: {
+ *                 Key: "STRING_VALUE", // required
+ *                 Value: {
+ *                   StringValue: "STRING_VALUE",
+ *                   StringListValue: [
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   LongValue: Number("long"),
+ *                   DateValue: new Date("TIMESTAMP"),
+ *                 },
+ *               },
+ *             },
+ *             EqualsTo: "<AttributeFilter>",
+ *             ContainsAll: "<AttributeFilter>",
+ *             ContainsAny: "<AttributeFilter>",
+ *             GreaterThan: "<AttributeFilter>",
+ *             GreaterThanOrEquals: "<AttributeFilter>",
+ *             LessThan: "<AttributeFilter>",
+ *             LessThanOrEquals: "<AttributeFilter>",
+ *           },
+ *         ],
+ *         OrAllFilters: "<AttributeFilter>",
+ *         NotFilter: "<AttributeFilter>",
+ *         EqualsTo: "<AttributeFilter>",
+ *         ContainsAll: "<AttributeFilter>",
+ *         ContainsAny: "<AttributeFilter>",
+ *         GreaterThan: "<AttributeFilter>",
+ *         GreaterThanOrEquals: "<AttributeFilter>",
+ *         LessThan: "<AttributeFilter>",
+ *         LessThanOrEquals: "<AttributeFilter>",
+ *       },
+ *     ],
+ *     OrAllFilters: "<AttributeFilter>",
+ *     NotFilter: "<AttributeFilter>",
+ *     EqualsTo: "<AttributeFilter>",
+ *     ContainsAll: "<AttributeFilter>",
+ *     ContainsAny: "<AttributeFilter>",
+ *     GreaterThan: "<AttributeFilter>",
+ *     GreaterThanOrEquals: "<AttributeFilter>",
+ *     LessThan: "<AttributeFilter>",
+ *     LessThanOrEquals: "<AttributeFilter>",
+ *   },
+ *   Facets: [
+ *     {
+ *       DocumentAttributeKey: "STRING_VALUE",
+ *       Facets: [
+ *         {
+ *           DocumentAttributeKey: "STRING_VALUE",
+ *           Facets: [
+ *             "<FacetList>",
+ *           ],
+ *           MaxResults: Number("int"),
+ *         },
+ *       ],
+ *       MaxResults: Number("int"),
+ *     },
+ *   ],
+ *   RequestedDocumentAttributes: [
+ *     "STRING_VALUE",
+ *   ],
+ *   QueryResultTypeFilter: "DOCUMENT" || "QUESTION_ANSWER" || "ANSWER",
+ *   DocumentRelevanceOverrideConfigurations: [
+ *     {
+ *       Name: "STRING_VALUE", // required
+ *       Relevance: {
+ *         Freshness: true || false,
+ *         Importance: Number("int"),
+ *         Duration: "STRING_VALUE",
+ *         RankOrder: "ASCENDING" || "DESCENDING",
+ *         ValueImportanceMap: {
+ *           "<keys>": Number("int"),
+ *         },
+ *       },
+ *     },
+ *   ],
+ *   PageNumber: Number("int"),
+ *   PageSize: Number("int"),
+ *   SortingConfiguration: {
+ *     DocumentAttributeKey: "STRING_VALUE", // required
+ *     SortOrder: "DESC" || "ASC", // required
+ *   },
+ *   UserContext: {
+ *     Token: "STRING_VALUE",
+ *     UserId: "STRING_VALUE",
+ *     Groups: [
+ *       "STRING_VALUE",
+ *     ],
+ *     DataSourceGroups: [
+ *       {
+ *         GroupId: "STRING_VALUE", // required
+ *         DataSourceId: "STRING_VALUE", // required
+ *       },
+ *     ],
+ *   },
+ *   VisitorId: "STRING_VALUE",
+ *   SpellCorrectionConfiguration: {
+ *     IncludeQuerySpellCheckSuggestions: true || false, // required
+ *   },
+ * };
  * const command = new QueryCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -28,6 +28,10 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync
  * import { KendraClient, StartDataSourceSyncJobCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, StartDataSourceSyncJobCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = {
+ *   Id: "STRING_VALUE", // required
+ *   IndexId: "STRING_VALUE", // required
+ * };
  * const command = new StartDataSourceSyncJobCommand(input);
  * const response = await client.send(command);
  * ```

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

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

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

@@ -30,6 +30,22 @@ export interface SubmitFeedbackCommandOutput extends __MetadataBearer {
  * import { KendraClient, SubmitFeedbackCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, SubmitFeedbackCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
+ * const input = {
+ *   IndexId: "STRING_VALUE", // required
+ *   QueryId: "STRING_VALUE", // required
+ *   ClickFeedbackItems: [
+ *     {
+ *       ResultId: "STRING_VALUE", // required
+ *       ClickTime: new Date("TIMESTAMP"), // required
+ *     },
+ *   ],
+ *   RelevanceFeedbackItems: [
+ *     {
+ *       ResultId: "STRING_VALUE", // required
+ *       RelevanceValue: "RELEVANT" || "NOT_RELEVANT", // required
+ *     },
+ *   ],
+ * };
  * const command = new SubmitFeedbackCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -28,6 +28,15 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * 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 = {
+ *   ResourceARN: "STRING_VALUE", // required
+ *   Tags: [ // required
+ *     {
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
  * const command = new TagResourceCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,12 @@ 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 = {
+ *   ResourceARN: "STRING_VALUE", // required
+ *   TagKeys: [ // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
  * const command = new UntagResourceCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -45,6 +45,32 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
  * 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 = {
+ *   IndexId: "STRING_VALUE", // required
+ *   Id: "STRING_VALUE", // required
+ *   Name: "STRING_VALUE",
+ *   Description: "STRING_VALUE",
+ *   AccessControlList: [
+ *     {
+ *       Name: "STRING_VALUE", // required
+ *       Type: "USER" || "GROUP", // required
+ *       Access: "ALLOW" || "DENY", // required
+ *       DataSourceId: "STRING_VALUE",
+ *     },
+ *   ],
+ *   HierarchicalAccessControlList: [
+ *     {
+ *       PrincipalList: [ // required
+ *         {
+ *           Name: "STRING_VALUE", // required
+ *           Type: "USER" || "GROUP", // required
+ *           Access: "ALLOW" || "DENY", // required
+ *           DataSourceId: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *   ],
+ * };
  * const command = new UpdateAccessControlConfigurationCommand(input);
  * const response = await client.send(command);
  * ```