@aws-sdk/client-kendra 3.300.0 → 3.301.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.
- package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +3 -3
- package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +3 -3
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +3 -3
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +7 -7
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +18 -18
- package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/CreateDataSourceCommand.d.ts +168 -338
- package/dist-types/commands/CreateExperienceCommand.d.ts +6 -6
- package/dist-types/commands/CreateFaqCommand.d.ts +4 -4
- package/dist-types/commands/CreateIndexCommand.d.ts +9 -9
- package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +4 -4
- package/dist-types/commands/CreateThesaurusCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFaqCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFaqCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +3 -3
- package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +2 -2
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +1 -1
- package/dist-types/commands/GetSnapshotsCommand.d.ts +1 -1
- package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListEntityPersonasCommand.d.ts +1 -1
- package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/ListExperiencesCommand.d.ts +1 -1
- package/dist-types/commands/ListFaqsCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +1 -1
- package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListThesauriCommand.d.ts +1 -1
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +7 -7
- package/dist-types/commands/QueryCommand.d.ts +88 -213
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +5 -5
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +166 -336
- package/dist-types/commands/UpdateExperienceCommand.d.ts +6 -6
- package/dist-types/commands/UpdateIndexCommand.d.ts +12 -12
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +2 -2
- package/package.json +3 -3
|
@@ -30,11 +30,11 @@ export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEnt
|
|
|
30
30
|
* import { KendraClient, AssociateEntitiesToExperienceCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
31
31
|
* // const { KendraClient, AssociateEntitiesToExperienceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
32
32
|
* const client = new KendraClient(config);
|
|
33
|
-
* const input = {
|
|
33
|
+
* const input = { // AssociateEntitiesToExperienceRequest
|
|
34
34
|
* Id: "STRING_VALUE", // required
|
|
35
35
|
* IndexId: "STRING_VALUE", // required
|
|
36
|
-
* EntityList: [ // required
|
|
37
|
-
* {
|
|
36
|
+
* EntityList: [ // AssociateEntityList // required
|
|
37
|
+
* { // EntityConfiguration
|
|
38
38
|
* EntityId: "STRING_VALUE", // required
|
|
39
39
|
* EntityType: "USER" || "GROUP", // required
|
|
40
40
|
* },
|
|
@@ -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
|
* },
|
|
@@ -30,12 +30,12 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
|
|
|
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
|
* },
|
|
@@ -38,17 +38,17 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
|
|
|
38
38
|
* import { KendraClient, BatchGetDocumentStatusCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
39
39
|
* // const { KendraClient, BatchGetDocumentStatusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
40
40
|
* const client = new KendraClient(config);
|
|
41
|
-
* const input = {
|
|
41
|
+
* const input = { // BatchGetDocumentStatusRequest
|
|
42
42
|
* IndexId: "STRING_VALUE", // required
|
|
43
|
-
* DocumentInfoList: [ // required
|
|
44
|
-
* {
|
|
43
|
+
* DocumentInfoList: [ // DocumentInfoList // required
|
|
44
|
+
* { // DocumentInfo
|
|
45
45
|
* DocumentId: "STRING_VALUE", // required
|
|
46
|
-
* Attributes: [
|
|
47
|
-
* {
|
|
46
|
+
* Attributes: [ // DocumentAttributeList
|
|
47
|
+
* { // DocumentAttribute
|
|
48
48
|
* Key: "STRING_VALUE", // required
|
|
49
|
-
* Value: {
|
|
49
|
+
* Value: { // DocumentAttributeValue
|
|
50
50
|
* StringValue: "STRING_VALUE",
|
|
51
|
-
* StringListValue: [
|
|
51
|
+
* StringListValue: [ // DocumentAttributeStringListValue
|
|
52
52
|
* "STRING_VALUE",
|
|
53
53
|
* ],
|
|
54
54
|
* LongValue: Number("long"),
|
|
@@ -37,24 +37,24 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
|
|
|
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
|
|
@@ -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);
|
|
@@ -48,20 +48,20 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
|
|
|
48
48
|
* import { KendraClient, CreateAccessControlConfigurationCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
49
49
|
* // const { KendraClient, CreateAccessControlConfigurationCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
50
50
|
* const client = new KendraClient(config);
|
|
51
|
-
* const input = {
|
|
51
|
+
* const input = { // CreateAccessControlConfigurationRequest
|
|
52
52
|
* IndexId: "STRING_VALUE", // required
|
|
53
53
|
* Name: "STRING_VALUE", // required
|
|
54
54
|
* Description: "STRING_VALUE",
|
|
55
|
-
* AccessControlList: [
|
|
56
|
-
* {
|
|
55
|
+
* AccessControlList: [ // PrincipalList
|
|
56
|
+
* { // Principal
|
|
57
57
|
* Name: "STRING_VALUE", // required
|
|
58
58
|
* Type: "USER" || "GROUP", // required
|
|
59
59
|
* Access: "ALLOW" || "DENY", // required
|
|
60
60
|
* DataSourceId: "STRING_VALUE",
|
|
61
61
|
* },
|
|
62
62
|
* ],
|
|
63
|
-
* HierarchicalAccessControlList: [
|
|
64
|
-
* {
|
|
63
|
+
* HierarchicalAccessControlList: [ // HierarchicalPrincipalList
|
|
64
|
+
* { // HierarchicalPrincipal
|
|
65
65
|
* PrincipalList: [ // required
|
|
66
66
|
* {
|
|
67
67
|
* Name: "STRING_VALUE", // required
|