@aws-sdk/client-kendra 3.300.0 → 3.303.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/Kendra.js +75 -0
  3. package/dist-cjs/commands/BatchDeleteFeaturedResultsSetCommand.js +45 -0
  4. package/dist-cjs/commands/CreateFeaturedResultsSetCommand.js +45 -0
  5. package/dist-cjs/commands/DescribeFeaturedResultsSetCommand.js +45 -0
  6. package/dist-cjs/commands/ListFeaturedResultsSetsCommand.js +45 -0
  7. package/dist-cjs/commands/UpdateFeaturedResultsSetCommand.js +45 -0
  8. package/dist-cjs/commands/index.js +5 -0
  9. package/dist-cjs/endpoint/ruleset.js +3 -3
  10. package/dist-cjs/models/models_0.js +381 -438
  11. package/dist-cjs/models/models_1.js +20 -0
  12. package/dist-cjs/protocols/Aws_json1_1.js +597 -4
  13. package/dist-es/Kendra.js +75 -0
  14. package/dist-es/commands/BatchDeleteFeaturedResultsSetCommand.js +41 -0
  15. package/dist-es/commands/CreateFeaturedResultsSetCommand.js +41 -0
  16. package/dist-es/commands/DescribeFeaturedResultsSetCommand.js +41 -0
  17. package/dist-es/commands/ListFeaturedResultsSetsCommand.js +41 -0
  18. package/dist-es/commands/UpdateFeaturedResultsSetCommand.js +41 -0
  19. package/dist-es/commands/index.js +5 -0
  20. package/dist-es/endpoint/ruleset.js +3 -3
  21. package/dist-es/models/models_0.js +377 -434
  22. package/dist-es/models/models_1.js +18 -1
  23. package/dist-es/protocols/Aws_json1_1.js +584 -1
  24. package/dist-types/Kendra.d.ts +163 -132
  25. package/dist-types/KendraClient.d.ts +7 -2
  26. package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +4 -4
  27. package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +4 -4
  28. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +9 -9
  29. package/dist-types/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +88 -0
  30. package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +16 -20
  31. package/dist-types/commands/BatchPutDocumentCommand.d.ts +32 -31
  32. package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +2 -2
  33. package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +22 -25
  34. package/dist-types/commands/CreateDataSourceCommand.d.ts +171 -342
  35. package/dist-types/commands/CreateExperienceCommand.d.ts +9 -8
  36. package/dist-types/commands/CreateFaqCommand.d.ts +10 -10
  37. package/dist-types/commands/CreateFeaturedResultsSetCommand.d.ts +117 -0
  38. package/dist-types/commands/CreateIndexCommand.d.ts +12 -11
  39. package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +7 -6
  40. package/dist-types/commands/CreateThesaurusCommand.d.ts +7 -6
  41. package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +6 -6
  42. package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -2
  43. package/dist-types/commands/DeleteExperienceCommand.d.ts +2 -2
  44. package/dist-types/commands/DeleteFaqCommand.d.ts +2 -2
  45. package/dist-types/commands/DeleteIndexCommand.d.ts +2 -2
  46. package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +14 -16
  47. package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +2 -2
  48. package/dist-types/commands/DeleteThesaurusCommand.d.ts +2 -2
  49. package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +4 -4
  50. package/dist-types/commands/DescribeDataSourceCommand.d.ts +2 -2
  51. package/dist-types/commands/DescribeExperienceCommand.d.ts +2 -2
  52. package/dist-types/commands/DescribeFaqCommand.d.ts +2 -2
  53. package/dist-types/commands/DescribeFeaturedResultsSetCommand.d.ts +86 -0
  54. package/dist-types/commands/DescribeIndexCommand.d.ts +2 -2
  55. package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +9 -10
  56. package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +2 -2
  57. package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +2 -2
  58. package/dist-types/commands/DescribeThesaurusCommand.d.ts +2 -2
  59. package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +4 -4
  60. package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +3 -3
  61. package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +4 -3
  62. package/dist-types/commands/GetSnapshotsCommand.d.ts +4 -5
  63. package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +6 -6
  64. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +3 -3
  65. package/dist-types/commands/ListDataSourcesCommand.d.ts +2 -2
  66. package/dist-types/commands/ListEntityPersonasCommand.d.ts +2 -2
  67. package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +2 -2
  68. package/dist-types/commands/ListExperiencesCommand.d.ts +2 -2
  69. package/dist-types/commands/ListFaqsCommand.d.ts +2 -2
  70. package/dist-types/commands/ListFeaturedResultsSetsCommand.d.ts +87 -0
  71. package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +5 -6
  72. package/dist-types/commands/ListIndicesCommand.d.ts +2 -2
  73. package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +2 -2
  74. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
  75. package/dist-types/commands/ListThesauriCommand.d.ts +2 -2
  76. package/dist-types/commands/PutPrincipalMappingCommand.d.ts +22 -28
  77. package/dist-types/commands/QueryCommand.d.ts +91 -215
  78. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +3 -3
  79. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +3 -3
  80. package/dist-types/commands/SubmitFeedbackCommand.d.ts +7 -7
  81. package/dist-types/commands/TagResourceCommand.d.ts +7 -8
  82. package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
  83. package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +25 -25
  84. package/dist-types/commands/UpdateDataSourceCommand.d.ts +168 -338
  85. package/dist-types/commands/UpdateExperienceCommand.d.ts +8 -8
  86. package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +105 -0
  87. package/dist-types/commands/UpdateIndexCommand.d.ts +16 -15
  88. package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +4 -4
  89. package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +2 -2
  90. package/dist-types/commands/UpdateThesaurusCommand.d.ts +3 -3
  91. package/dist-types/commands/index.d.ts +5 -0
  92. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  93. package/dist-types/models/models_0.d.ts +1943 -1687
  94. package/dist-types/models/models_1.d.ts +491 -72
  95. package/dist-types/protocols/Aws_json1_1.d.ts +15 -0
  96. package/dist-types/ts3.4/Kendra.d.ts +85 -0
  97. package/dist-types/ts3.4/KendraClient.d.ts +30 -0
  98. package/dist-types/ts3.4/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +41 -0
  99. package/dist-types/ts3.4/commands/CreateFeaturedResultsSetCommand.d.ts +41 -0
  100. package/dist-types/ts3.4/commands/DescribeFeaturedResultsSetCommand.d.ts +41 -0
  101. package/dist-types/ts3.4/commands/ListFeaturedResultsSetsCommand.d.ts +41 -0
  102. package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
  103. package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
  104. package/dist-types/ts3.4/commands/SubmitFeedbackCommand.d.ts +1 -1
  105. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  106. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  107. package/dist-types/ts3.4/commands/UpdateAccessControlConfigurationCommand.d.ts +1 -1
  108. package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
  109. package/dist-types/ts3.4/commands/UpdateExperienceCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/UpdateFeaturedResultsSetCommand.d.ts +41 -0
  111. package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +1 -1
  112. package/dist-types/ts3.4/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +1 -1
  113. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  114. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  115. package/dist-types/ts3.4/models/models_0.d.ts +563 -453
  116. package/dist-types/ts3.4/models/models_1.d.ts +127 -0
  117. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
  118. package/package.json +34 -34
@@ -30,11 +30,11 @@ export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePerso
30
30
  * import { KendraClient, AssociatePersonasToEntitiesCommand } from "@aws-sdk/client-kendra"; // ES Modules import
31
31
  * // const { KendraClient, AssociatePersonasToEntitiesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
32
32
  * const client = new KendraClient(config);
33
- * const input = {
33
+ * const input = { // AssociatePersonasToEntitiesRequest
34
34
  * Id: "STRING_VALUE", // required
35
35
  * IndexId: "STRING_VALUE", // required
36
- * Personas: [ // required
37
- * {
36
+ * Personas: [ // EntityPersonaConfigurationList // required
37
+ * { // EntityPersonaConfiguration
38
38
  * EntityId: "STRING_VALUE", // required
39
39
  * Persona: "OWNER" || "VIEWER", // required
40
40
  * },
@@ -56,7 +56,7 @@ export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePerso
56
56
  *
57
57
  * @throws {@link InternalServerException} (server fault)
58
58
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
59
- * 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>
59
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
60
60
  *
61
61
  * @throws {@link ResourceAlreadyExistException} (client fault)
62
62
  * <p>The resource you want to use already exists. Please check you have provided the
@@ -19,23 +19,23 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Removes one or more documents from an index. The documents must have
23
- * been added with the <code>BatchPutDocument</code> API.</p>
24
- * <p>The documents are deleted asynchronously. You can see the progress of
25
- * the deletion by using Amazon Web Services CloudWatch. Any error messages related to the
26
- * processing of the batch are sent to you CloudWatch log.</p>
22
+ * <p>Removes one or more documents from an index. The documents must have been added with
23
+ * the <code>BatchPutDocument</code> API.</p>
24
+ * <p>The documents are deleted asynchronously. You can see the progress of the deletion by
25
+ * using Amazon Web Services CloudWatch. Any error messages related to the processing of the
26
+ * batch are sent to you CloudWatch log.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
30
30
  * import { KendraClient, BatchDeleteDocumentCommand } from "@aws-sdk/client-kendra"; // ES Modules import
31
31
  * // const { KendraClient, BatchDeleteDocumentCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
32
32
  * const client = new KendraClient(config);
33
- * const input = {
33
+ * const input = { // BatchDeleteDocumentRequest
34
34
  * IndexId: "STRING_VALUE", // required
35
- * DocumentIdList: [ // required
35
+ * DocumentIdList: [ // DocumentIdList // required
36
36
  * "STRING_VALUE",
37
37
  * ],
38
- * DataSourceSyncJobMetricTarget: {
38
+ * DataSourceSyncJobMetricTarget: { // DataSourceSyncJobMetricTarget
39
39
  * DataSourceId: "STRING_VALUE", // required
40
40
  * DataSourceSyncJobId: "STRING_VALUE",
41
41
  * },
@@ -60,7 +60,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
60
60
  *
61
61
  * @throws {@link InternalServerException} (server fault)
62
62
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
63
- * 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>
63
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
64
64
  *
65
65
  * @throws {@link ResourceNotFoundException} (client fault)
66
66
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -0,0 +1,88 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
+ import { BatchDeleteFeaturedResultsSetRequest, BatchDeleteFeaturedResultsSetResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link BatchDeleteFeaturedResultsSetCommand}.
10
+ */
11
+ export interface BatchDeleteFeaturedResultsSetCommandInput extends BatchDeleteFeaturedResultsSetRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link BatchDeleteFeaturedResultsSetCommand}.
17
+ */
18
+ export interface BatchDeleteFeaturedResultsSetCommandOutput extends BatchDeleteFeaturedResultsSetResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Removes one or more sets of featured results. Features results are placed
23
+ * above all other results for certain queries. If there's an exact match of a
24
+ * query, then one or more specific documents are featured in the search results.</p>
25
+ * @example
26
+ * Use a bare-bones client and the command you need to make an API call.
27
+ * ```javascript
28
+ * import { KendraClient, BatchDeleteFeaturedResultsSetCommand } from "@aws-sdk/client-kendra"; // ES Modules import
29
+ * // const { KendraClient, BatchDeleteFeaturedResultsSetCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
30
+ * const client = new KendraClient(config);
31
+ * const input = { // BatchDeleteFeaturedResultsSetRequest
32
+ * IndexId: "STRING_VALUE", // required
33
+ * FeaturedResultsSetIds: [ // FeaturedResultsSetIdList // required
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * };
37
+ * const command = new BatchDeleteFeaturedResultsSetCommand(input);
38
+ * const response = await client.send(command);
39
+ * ```
40
+ *
41
+ * @param BatchDeleteFeaturedResultsSetCommandInput - {@link BatchDeleteFeaturedResultsSetCommandInput}
42
+ * @returns {@link BatchDeleteFeaturedResultsSetCommandOutput}
43
+ * @see {@link BatchDeleteFeaturedResultsSetCommandInput} for command's `input` shape.
44
+ * @see {@link BatchDeleteFeaturedResultsSetCommandOutput} for command's `response` shape.
45
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
46
+ *
47
+ * @throws {@link AccessDeniedException} (client fault)
48
+ * <p>You don't have sufficient access to perform this action. Please ensure you have the
49
+ * required permission policies and user accounts and try again.</p>
50
+ *
51
+ * @throws {@link InternalServerException} (server fault)
52
+ * <p>An issue occurred with the internal server used for your Amazon Kendra service.
53
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
54
+ *
55
+ * @throws {@link ResourceNotFoundException} (client fault)
56
+ * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
57
+ * resource and try again.</p>
58
+ *
59
+ * @throws {@link ThrottlingException} (client fault)
60
+ * <p>The request was denied due to request throttling. Please reduce the number of requests
61
+ * and try again.</p>
62
+ *
63
+ * @throws {@link ValidationException} (client fault)
64
+ * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
65
+ * Please provide the correct input and try again.</p>
66
+ *
67
+ *
68
+ */
69
+ export declare class BatchDeleteFeaturedResultsSetCommand extends $Command<BatchDeleteFeaturedResultsSetCommandInput, BatchDeleteFeaturedResultsSetCommandOutput, KendraClientResolvedConfig> {
70
+ readonly input: BatchDeleteFeaturedResultsSetCommandInput;
71
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
75
+ constructor(input: BatchDeleteFeaturedResultsSetCommandInput);
76
+ /**
77
+ * @internal
78
+ */
79
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteFeaturedResultsSetCommandInput, BatchDeleteFeaturedResultsSetCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
83
+ private serialize;
84
+ /**
85
+ * @internal
86
+ */
87
+ private deserialize;
88
+ }
@@ -19,36 +19,32 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Returns the indexing status for one or more documents submitted
23
- * with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
22
+ * <p>Returns the indexing status for one or more documents submitted with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
24
23
  * BatchPutDocument</a> API.</p>
25
- * <p>When you use the <code>BatchPutDocument</code> API,
26
- * documents are indexed asynchronously. You can use the
27
- * <code>BatchGetDocumentStatus</code> API to get the current
28
- * status of a list of documents so that you can determine if they have
29
- * been successfully indexed.</p>
30
- * <p>You can also use the <code>BatchGetDocumentStatus</code> API
31
- * to check the status of the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html">
32
- * BatchDeleteDocument</a> API. When a document is
33
- * deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the
34
- * status.</p>
24
+ * <p>When you use the <code>BatchPutDocument</code> API, documents are indexed
25
+ * asynchronously. You can use the <code>BatchGetDocumentStatus</code> API to get the
26
+ * current status of a list of documents so that you can determine if they have been
27
+ * successfully indexed.</p>
28
+ * <p>You can also use the <code>BatchGetDocumentStatus</code> API to check the status of
29
+ * the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html">
30
+ * BatchDeleteDocument</a> API. When a document is deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the status.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
38
34
  * import { KendraClient, BatchGetDocumentStatusCommand } from "@aws-sdk/client-kendra"; // ES Modules import
39
35
  * // const { KendraClient, BatchGetDocumentStatusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
40
36
  * const client = new KendraClient(config);
41
- * const input = {
37
+ * const input = { // BatchGetDocumentStatusRequest
42
38
  * IndexId: "STRING_VALUE", // required
43
- * DocumentInfoList: [ // required
44
- * {
39
+ * DocumentInfoList: [ // DocumentInfoList // required
40
+ * { // DocumentInfo
45
41
  * DocumentId: "STRING_VALUE", // required
46
- * Attributes: [
47
- * {
42
+ * Attributes: [ // DocumentAttributeList
43
+ * { // DocumentAttribute
48
44
  * Key: "STRING_VALUE", // required
49
- * Value: {
45
+ * Value: { // DocumentAttributeValue
50
46
  * StringValue: "STRING_VALUE",
51
- * StringListValue: [
47
+ * StringListValue: [ // DocumentAttributeStringListValue
52
48
  * "STRING_VALUE",
53
49
  * ],
54
50
  * LongValue: Number("long"),
@@ -79,7 +75,7 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
79
75
  *
80
76
  * @throws {@link InternalServerException} (server fault)
81
77
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
82
- * 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>
78
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
83
79
  *
84
80
  * @throws {@link ResourceNotFoundException} (client fault)
85
81
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -20,41 +20,41 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
20
20
  /**
21
21
  * @public
22
22
  * <p>Adds one or more documents to an index.</p>
23
- * <p>The <code>BatchPutDocument</code> API enables you to ingest
24
- * inline documents or a set of documents stored in an Amazon S3 bucket. Use
25
- * this API to ingest your text and unstructured text into an index,
26
- * add custom attributes to the documents, and to attach an access control
27
- * list to the documents added to the index.</p>
28
- * <p>The documents are indexed asynchronously. You can see the progress of
29
- * the batch using Amazon Web Services CloudWatch. Any error messages related to processing
30
- * the batch are sent to your Amazon Web Services CloudWatch log.</p>
31
- * <p>For an example of ingesting inline documents using Python and Java SDKs,
32
- * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding
33
- * files directly to an index</a>.</p>
23
+ * <p>The <code>BatchPutDocument</code> API enables you to ingest inline documents or a set
24
+ * of documents stored in an Amazon S3 bucket. Use this API to ingest your text and
25
+ * unstructured text into an index, add custom attributes to the documents, and to attach
26
+ * an access control list to the documents added to the index.</p>
27
+ * <p>The documents are indexed asynchronously. You can see the progress of the batch using
28
+ * Amazon Web Services
29
+ * CloudWatch. Any error messages related to processing the batch are sent to your
30
+ * Amazon Web Services
31
+ * CloudWatch log.</p>
32
+ * <p>For an example of ingesting inline documents using Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding files
33
+ * directly to an index</a>.</p>
34
34
  * @example
35
35
  * Use a bare-bones client and the command you need to make an API call.
36
36
  * ```javascript
37
37
  * import { KendraClient, BatchPutDocumentCommand } from "@aws-sdk/client-kendra"; // ES Modules import
38
38
  * // const { KendraClient, BatchPutDocumentCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
39
39
  * const client = new KendraClient(config);
40
- * const input = {
40
+ * const input = { // BatchPutDocumentRequest
41
41
  * IndexId: "STRING_VALUE", // required
42
42
  * RoleArn: "STRING_VALUE",
43
- * Documents: [ // required
44
- * {
43
+ * Documents: [ // DocumentList // required
44
+ * { // Document
45
45
  * Id: "STRING_VALUE", // required
46
46
  * Title: "STRING_VALUE",
47
47
  * Blob: "BLOB_VALUE",
48
- * S3Path: {
48
+ * S3Path: { // S3Path
49
49
  * Bucket: "STRING_VALUE", // required
50
50
  * Key: "STRING_VALUE", // required
51
51
  * },
52
- * Attributes: [
53
- * {
52
+ * Attributes: [ // DocumentAttributeList
53
+ * { // DocumentAttribute
54
54
  * Key: "STRING_VALUE", // required
55
- * Value: {
55
+ * Value: { // DocumentAttributeValue
56
56
  * StringValue: "STRING_VALUE",
57
- * StringListValue: [
57
+ * StringListValue: [ // DocumentAttributeStringListValue
58
58
  * "STRING_VALUE",
59
59
  * ],
60
60
  * LongValue: Number("long"),
@@ -62,16 +62,16 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
62
62
  * },
63
63
  * },
64
64
  * ],
65
- * AccessControlList: [
66
- * {
65
+ * AccessControlList: [ // PrincipalList
66
+ * { // Principal
67
67
  * Name: "STRING_VALUE", // required
68
68
  * Type: "USER" || "GROUP", // required
69
69
  * Access: "ALLOW" || "DENY", // required
70
70
  * DataSourceId: "STRING_VALUE",
71
71
  * },
72
72
  * ],
73
- * HierarchicalAccessControlList: [
74
- * {
73
+ * HierarchicalAccessControlList: [ // HierarchicalPrincipalList
74
+ * { // HierarchicalPrincipal
75
75
  * PrincipalList: [ // required
76
76
  * {
77
77
  * Name: "STRING_VALUE", // required
@@ -86,10 +86,10 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
86
86
  * AccessControlConfigurationId: "STRING_VALUE",
87
87
  * },
88
88
  * ],
89
- * CustomDocumentEnrichmentConfiguration: {
90
- * InlineConfigurations: [
91
- * {
92
- * Condition: {
89
+ * CustomDocumentEnrichmentConfiguration: { // CustomDocumentEnrichmentConfiguration
90
+ * InlineConfigurations: [ // InlineCustomDocumentEnrichmentConfigurationList
91
+ * { // InlineCustomDocumentEnrichmentConfiguration
92
+ * Condition: { // DocumentAttributeCondition
93
93
  * ConditionDocumentAttributeKey: "STRING_VALUE", // required
94
94
  * Operator: "GreaterThan" || "GreaterThanOrEquals" || "LessThan" || "LessThanOrEquals" || "Equals" || "NotEquals" || "Contains" || "NotContains" || "Exists" || "NotExists" || "BeginsWith", // required
95
95
  * ConditionOnValue: {
@@ -101,7 +101,7 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
101
101
  * DateValue: new Date("TIMESTAMP"),
102
102
  * },
103
103
  * },
104
- * Target: {
104
+ * Target: { // DocumentAttributeTarget
105
105
  * TargetDocumentAttributeKey: "STRING_VALUE",
106
106
  * TargetDocumentAttributeValueDeletion: true || false,
107
107
  * TargetDocumentAttributeValue: {
@@ -116,7 +116,7 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
116
116
  * DocumentContentDeletion: true || false,
117
117
  * },
118
118
  * ],
119
- * PreExtractionHookConfiguration: {
119
+ * PreExtractionHookConfiguration: { // HookConfiguration
120
120
  * InvocationCondition: {
121
121
  * ConditionDocumentAttributeKey: "STRING_VALUE", // required
122
122
  * Operator: "GreaterThan" || "GreaterThanOrEquals" || "LessThan" || "LessThanOrEquals" || "Equals" || "NotEquals" || "Contains" || "NotContains" || "Exists" || "NotExists" || "BeginsWith", // required
@@ -171,7 +171,7 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
171
171
  *
172
172
  * @throws {@link InternalServerException} (server fault)
173
173
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
174
- * 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>
174
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
175
175
  *
176
176
  * @throws {@link ResourceNotFoundException} (client fault)
177
177
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -179,7 +179,8 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
179
179
  *
180
180
  * @throws {@link ServiceQuotaExceededException} (client fault)
181
181
  * <p>You have exceeded the set limits for your Amazon Kendra service. Please see
182
- * 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
182
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
183
+ * more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
183
184
  * an increase of limits.</p>
184
185
  *
185
186
  * @throws {@link ThrottlingException} (client fault)
@@ -35,7 +35,7 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
35
35
  * import { KendraClient, ClearQuerySuggestionsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
36
36
  * // const { KendraClient, ClearQuerySuggestionsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
37
37
  * const client = new KendraClient(config);
38
- * const input = {
38
+ * const input = { // ClearQuerySuggestionsRequest
39
39
  * IndexId: "STRING_VALUE", // required
40
40
  * };
41
41
  * const command = new ClearQuerySuggestionsCommand(input);
@@ -58,7 +58,7 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
58
58
  *
59
59
  * @throws {@link InternalServerException} (server fault)
60
60
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
61
- * 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>
61
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
62
62
  *
63
63
  * @throws {@link ResourceNotFoundException} (client fault)
64
64
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -19,49 +19,45 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Creates an access configuration for your documents. This includes
23
- * user and group access information for your documents. This is useful
24
- * for user context filtering, where search results are filtered based
25
- * on the user or their group access to documents.</p>
22
+ * <p>Creates an access configuration for your documents. This includes user and group
23
+ * access information for your documents. This is useful for user context filtering, where
24
+ * search results are filtered based on the user or their group access to documents.</p>
26
25
  * <p>You can use this to re-configure your existing document level access control without
27
26
  * indexing all of your documents again. For example, your index contains top-secret
28
27
  * company documents that only certain employees or users should access. One of these users
29
28
  * leaves the company or switches to a team that should be blocked from accessing
30
29
  * top-secret documents. The user still has access to top-secret documents because the user
31
- * had access when your documents were previously indexed. You
32
- * can create a specific access control configuration for the user with deny
33
- * access. You can later update the access control configuration to allow access if the
34
- * user returns to the company and re-joins the 'top-secret' team. You can re-configure
35
- * access control for your documents as circumstances change.</p>
36
- * <p>To apply your access control configuration to certain documents, you call
37
- * the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
38
- * API with the <code>AccessControlConfigurationId</code> included in the
39
- * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
40
- * object. If you use an S3 bucket as a data source, you update the
41
- * <code>.metadata.json</code> with the <code>AccessControlConfigurationId</code>
42
- * and synchronize your data source. Amazon Kendra currently only supports
43
- * access control configuration for S3 data sources and documents indexed using the
44
- * <code>BatchPutDocument</code> API.</p>
30
+ * had access when your documents were previously indexed. You can create a specific access
31
+ * control configuration for the user with deny access. You can later update the access
32
+ * control configuration to allow access if the user returns to the company and re-joins
33
+ * the 'top-secret' team. You can re-configure access control for your documents as
34
+ * circumstances change.</p>
35
+ * <p>To apply your access control configuration to certain documents, you call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API with the <code>AccessControlConfigurationId</code>
36
+ * 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 update the
37
+ * <code>.metadata.json</code> with the <code>AccessControlConfigurationId</code> and
38
+ * synchronize your data source. Amazon Kendra currently only supports access control
39
+ * configuration for S3 data sources and documents indexed using the
40
+ * <code>BatchPutDocument</code> API.</p>
45
41
  * @example
46
42
  * Use a bare-bones client and the command you need to make an API call.
47
43
  * ```javascript
48
44
  * import { KendraClient, CreateAccessControlConfigurationCommand } from "@aws-sdk/client-kendra"; // ES Modules import
49
45
  * // const { KendraClient, CreateAccessControlConfigurationCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
50
46
  * const client = new KendraClient(config);
51
- * const input = {
47
+ * const input = { // CreateAccessControlConfigurationRequest
52
48
  * IndexId: "STRING_VALUE", // required
53
49
  * Name: "STRING_VALUE", // required
54
50
  * Description: "STRING_VALUE",
55
- * AccessControlList: [
56
- * {
51
+ * AccessControlList: [ // PrincipalList
52
+ * { // Principal
57
53
  * Name: "STRING_VALUE", // required
58
54
  * Type: "USER" || "GROUP", // required
59
55
  * Access: "ALLOW" || "DENY", // required
60
56
  * DataSourceId: "STRING_VALUE",
61
57
  * },
62
58
  * ],
63
- * HierarchicalAccessControlList: [
64
- * {
59
+ * HierarchicalAccessControlList: [ // HierarchicalPrincipalList
60
+ * { // HierarchicalPrincipal
65
61
  * PrincipalList: [ // required
66
62
  * {
67
63
  * Name: "STRING_VALUE", // required
@@ -94,7 +90,7 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
94
90
  *
95
91
  * @throws {@link InternalServerException} (server fault)
96
92
  * <p>An issue occurred with the internal server used for your Amazon Kendra service.
97
- * 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>
93
+ * Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
98
94
  *
99
95
  * @throws {@link ResourceNotFoundException} (client fault)
100
96
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -102,7 +98,8 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
102
98
  *
103
99
  * @throws {@link ServiceQuotaExceededException} (client fault)
104
100
  * <p>You have exceeded the set limits for your Amazon Kendra service. Please see
105
- * 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
101
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
102
+ * more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
106
103
  * an increase of limits.</p>
107
104
  *
108
105
  * @throws {@link ThrottlingException} (client fault)