@aws-sdk/client-kendra 3.325.0 → 3.326.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 +11 -0
- package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +11 -0
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +12 -0
- package/dist-types/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +12 -0
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +20 -0
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +12 -0
- package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +4 -0
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +6 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +6 -0
- package/dist-types/commands/CreateExperienceCommand.d.ts +6 -0
- package/dist-types/commands/CreateFaqCommand.d.ts +6 -0
- package/dist-types/commands/CreateFeaturedResultsSetCommand.d.ts +21 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +6 -0
- package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +6 -0
- package/dist-types/commands/CreateThesaurusCommand.d.ts +6 -0
- package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +4 -0
- package/dist-types/commands/DeleteExperienceCommand.d.ts +4 -0
- package/dist-types/commands/DeleteFaqCommand.d.ts +4 -0
- package/dist-types/commands/DeleteIndexCommand.d.ts +4 -0
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +4 -0
- package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +4 -0
- package/dist-types/commands/DeleteThesaurusCommand.d.ts +4 -0
- package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +28 -0
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +570 -0
- package/dist-types/commands/DescribeExperienceCommand.d.ts +34 -0
- package/dist-types/commands/DescribeFaqCommand.d.ts +20 -0
- package/dist-types/commands/DescribeFeaturedResultsSetCommand.d.ts +26 -0
- package/dist-types/commands/DescribeIndexCommand.d.ts +72 -0
- package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +17 -0
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +20 -0
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +14 -0
- package/dist-types/commands/DescribeThesaurusCommand.d.ts +21 -0
- package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +11 -0
- package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +11 -0
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +22 -0
- package/dist-types/commands/GetSnapshotsCommand.d.ts +18 -0
- package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +11 -0
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +24 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +17 -0
- package/dist-types/commands/ListEntityPersonasCommand.d.ts +14 -0
- package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +19 -0
- package/dist-types/commands/ListExperiencesCommand.d.ts +20 -0
- package/dist-types/commands/ListFaqsCommand.d.ts +17 -0
- package/dist-types/commands/ListFeaturedResultsSetsCommand.d.ts +15 -0
- package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +12 -0
- package/dist-types/commands/ListIndicesCommand.d.ts +16 -0
- package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
- package/dist-types/commands/ListThesauriCommand.d.ts +15 -0
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +4 -0
- package/dist-types/commands/QueryCommand.d.ts +200 -0
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +6 -0
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +4 -0
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +4 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateExperienceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +21 -0
- package/dist-types/commands/UpdateIndexCommand.d.ts +4 -0
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +4 -0
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +4 -0
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +4 -0
- package/package.json +3 -3
|
@@ -42,6 +42,15 @@ export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEnt
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new AssociateEntitiesToExperienceCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // AssociateEntitiesToExperienceResponse
|
|
46
|
+
* // FailedEntityList: [ // AssociateEntitiesToExperienceFailedEntityList
|
|
47
|
+
* // { // FailedEntity
|
|
48
|
+
* // EntityId: "STRING_VALUE",
|
|
49
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
45
54
|
* ```
|
|
46
55
|
*
|
|
47
56
|
* @param AssociateEntitiesToExperienceCommandInput - {@link AssociateEntitiesToExperienceCommandInput}
|
|
@@ -74,6 +83,8 @@ export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEnt
|
|
|
74
83
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
75
84
|
* Please provide the correct input and try again.</p>
|
|
76
85
|
*
|
|
86
|
+
* @throws {@link KendraServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
77
88
|
*
|
|
78
89
|
*/
|
|
79
90
|
export declare class AssociateEntitiesToExperienceCommand extends $Command<AssociateEntitiesToExperienceCommandInput, AssociateEntitiesToExperienceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -42,6 +42,15 @@ export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePerso
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new AssociatePersonasToEntitiesCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // AssociatePersonasToEntitiesResponse
|
|
46
|
+
* // FailedEntityList: [ // FailedEntityList
|
|
47
|
+
* // { // FailedEntity
|
|
48
|
+
* // EntityId: "STRING_VALUE",
|
|
49
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
45
54
|
* ```
|
|
46
55
|
*
|
|
47
56
|
* @param AssociatePersonasToEntitiesCommandInput - {@link AssociatePersonasToEntitiesCommandInput}
|
|
@@ -74,6 +83,8 @@ export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePerso
|
|
|
74
83
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
75
84
|
* Please provide the correct input and try again.</p>
|
|
76
85
|
*
|
|
86
|
+
* @throws {@link KendraServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
77
88
|
*
|
|
78
89
|
*/
|
|
79
90
|
export declare class AssociatePersonasToEntitiesCommand extends $Command<AssociatePersonasToEntitiesCommandInput, AssociatePersonasToEntitiesCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -42,6 +42,16 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new BatchDeleteDocumentCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // BatchDeleteDocumentResponse
|
|
46
|
+
* // FailedDocuments: [ // BatchDeleteDocumentResponseFailedDocuments
|
|
47
|
+
* // { // BatchDeleteDocumentResponseFailedDocument
|
|
48
|
+
* // Id: "STRING_VALUE",
|
|
49
|
+
* // ErrorCode: "InternalError" || "InvalidRequest",
|
|
50
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
45
55
|
* ```
|
|
46
56
|
*
|
|
47
57
|
* @param BatchDeleteDocumentCommandInput - {@link BatchDeleteDocumentCommandInput}
|
|
@@ -74,6 +84,8 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
|
|
|
74
84
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
75
85
|
* Please provide the correct input and try again.</p>
|
|
76
86
|
*
|
|
87
|
+
* @throws {@link KendraServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
77
89
|
*
|
|
78
90
|
*/
|
|
79
91
|
export declare class BatchDeleteDocumentCommand extends $Command<BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -36,6 +36,16 @@ export interface BatchDeleteFeaturedResultsSetCommandOutput extends BatchDeleteF
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new BatchDeleteFeaturedResultsSetCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // BatchDeleteFeaturedResultsSetResponse
|
|
40
|
+
* // Errors: [ // BatchDeleteFeaturedResultsSetErrors // required
|
|
41
|
+
* // { // BatchDeleteFeaturedResultsSetError
|
|
42
|
+
* // Id: "STRING_VALUE", // required
|
|
43
|
+
* // ErrorCode: "InternalError" || "InvalidRequest", // required
|
|
44
|
+
* // ErrorMessage: "STRING_VALUE", // required
|
|
45
|
+
* // },
|
|
46
|
+
* // ],
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
39
49
|
* ```
|
|
40
50
|
*
|
|
41
51
|
* @param BatchDeleteFeaturedResultsSetCommandInput - {@link BatchDeleteFeaturedResultsSetCommandInput}
|
|
@@ -64,6 +74,8 @@ export interface BatchDeleteFeaturedResultsSetCommandOutput extends BatchDeleteF
|
|
|
64
74
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
65
75
|
* Please provide the correct input and try again.</p>
|
|
66
76
|
*
|
|
77
|
+
* @throws {@link KendraServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
67
79
|
*
|
|
68
80
|
*/
|
|
69
81
|
export declare class BatchDeleteFeaturedResultsSetCommand extends $Command<BatchDeleteFeaturedResultsSetCommandInput, BatchDeleteFeaturedResultsSetCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -57,6 +57,24 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
|
|
|
57
57
|
* };
|
|
58
58
|
* const command = new BatchGetDocumentStatusCommand(input);
|
|
59
59
|
* const response = await client.send(command);
|
|
60
|
+
* // { // BatchGetDocumentStatusResponse
|
|
61
|
+
* // Errors: [ // BatchGetDocumentStatusResponseErrors
|
|
62
|
+
* // { // BatchGetDocumentStatusResponseError
|
|
63
|
+
* // DocumentId: "STRING_VALUE",
|
|
64
|
+
* // ErrorCode: "InternalError" || "InvalidRequest",
|
|
65
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // DocumentStatusList: [ // DocumentStatusList
|
|
69
|
+
* // { // Status
|
|
70
|
+
* // DocumentId: "STRING_VALUE",
|
|
71
|
+
* // DocumentStatus: "NOT_FOUND" || "PROCESSING" || "INDEXED" || "UPDATED" || "FAILED" || "UPDATE_FAILED",
|
|
72
|
+
* // FailureCode: "STRING_VALUE",
|
|
73
|
+
* // FailureReason: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // };
|
|
77
|
+
*
|
|
60
78
|
* ```
|
|
61
79
|
*
|
|
62
80
|
* @param BatchGetDocumentStatusCommandInput - {@link BatchGetDocumentStatusCommandInput}
|
|
@@ -89,6 +107,8 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
|
|
|
89
107
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
90
108
|
* Please provide the correct input and try again.</p>
|
|
91
109
|
*
|
|
110
|
+
* @throws {@link KendraServiceException}
|
|
111
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
92
112
|
*
|
|
93
113
|
*/
|
|
94
114
|
export declare class BatchGetDocumentStatusCommand extends $Command<BatchGetDocumentStatusCommandInput, BatchGetDocumentStatusCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -153,6 +153,16 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
|
|
|
153
153
|
* };
|
|
154
154
|
* const command = new BatchPutDocumentCommand(input);
|
|
155
155
|
* const response = await client.send(command);
|
|
156
|
+
* // { // BatchPutDocumentResponse
|
|
157
|
+
* // FailedDocuments: [ // BatchPutDocumentResponseFailedDocuments
|
|
158
|
+
* // { // BatchPutDocumentResponseFailedDocument
|
|
159
|
+
* // Id: "STRING_VALUE",
|
|
160
|
+
* // ErrorCode: "InternalError" || "InvalidRequest",
|
|
161
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
162
|
+
* // },
|
|
163
|
+
* // ],
|
|
164
|
+
* // };
|
|
165
|
+
*
|
|
156
166
|
* ```
|
|
157
167
|
*
|
|
158
168
|
* @param BatchPutDocumentCommandInput - {@link BatchPutDocumentCommandInput}
|
|
@@ -191,6 +201,8 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
|
|
|
191
201
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
192
202
|
* Please provide the correct input and try again.</p>
|
|
193
203
|
*
|
|
204
|
+
* @throws {@link KendraServiceException}
|
|
205
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
194
206
|
*
|
|
195
207
|
*/
|
|
196
208
|
export declare class BatchPutDocumentCommand extends $Command<BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -40,6 +40,8 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new ClearQuerySuggestionsCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
43
45
|
* ```
|
|
44
46
|
*
|
|
45
47
|
* @param ClearQuerySuggestionsCommandInput - {@link ClearQuerySuggestionsCommandInput}
|
|
@@ -72,6 +74,8 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
|
|
|
72
74
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
73
75
|
* Please provide the correct input and try again.</p>
|
|
74
76
|
*
|
|
77
|
+
* @throws {@link KendraServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
75
79
|
*
|
|
76
80
|
*/
|
|
77
81
|
export declare class ClearQuerySuggestionsCommand extends $Command<ClearQuerySuggestionsCommandInput, ClearQuerySuggestionsCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -72,6 +72,10 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
|
|
|
72
72
|
* };
|
|
73
73
|
* const command = new CreateAccessControlConfigurationCommand(input);
|
|
74
74
|
* const response = await client.send(command);
|
|
75
|
+
* // { // CreateAccessControlConfigurationResponse
|
|
76
|
+
* // Id: "STRING_VALUE", // required
|
|
77
|
+
* // };
|
|
78
|
+
*
|
|
75
79
|
* ```
|
|
76
80
|
*
|
|
77
81
|
* @param CreateAccessControlConfigurationCommandInput - {@link CreateAccessControlConfigurationCommandInput}
|
|
@@ -110,6 +114,8 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
|
|
|
110
114
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
111
115
|
* Please provide the correct input and try again.</p>
|
|
112
116
|
*
|
|
117
|
+
* @throws {@link KendraServiceException}
|
|
118
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
113
119
|
*
|
|
114
120
|
*/
|
|
115
121
|
export declare class CreateAccessControlConfigurationCommand extends $Command<CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -607,6 +607,10 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
|
|
|
607
607
|
* };
|
|
608
608
|
* const command = new CreateDataSourceCommand(input);
|
|
609
609
|
* const response = await client.send(command);
|
|
610
|
+
* // { // CreateDataSourceResponse
|
|
611
|
+
* // Id: "STRING_VALUE", // required
|
|
612
|
+
* // };
|
|
613
|
+
*
|
|
610
614
|
* ```
|
|
611
615
|
*
|
|
612
616
|
* @param CreateDataSourceCommandInput - {@link CreateDataSourceCommandInput}
|
|
@@ -649,6 +653,8 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
|
|
|
649
653
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
650
654
|
* Please provide the correct input and try again.</p>
|
|
651
655
|
*
|
|
656
|
+
* @throws {@link KendraServiceException}
|
|
657
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
652
658
|
*
|
|
653
659
|
*/
|
|
654
660
|
export declare class CreateDataSourceCommand extends $Command<CreateDataSourceCommandInput, CreateDataSourceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -52,6 +52,10 @@ export interface CreateExperienceCommandOutput extends CreateExperienceResponse,
|
|
|
52
52
|
* };
|
|
53
53
|
* const command = new CreateExperienceCommand(input);
|
|
54
54
|
* const response = await client.send(command);
|
|
55
|
+
* // { // CreateExperienceResponse
|
|
56
|
+
* // Id: "STRING_VALUE", // required
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
55
59
|
* ```
|
|
56
60
|
*
|
|
57
61
|
* @param CreateExperienceCommandInput - {@link CreateExperienceCommandInput}
|
|
@@ -90,6 +94,8 @@ export interface CreateExperienceCommandOutput extends CreateExperienceResponse,
|
|
|
90
94
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
91
95
|
* Please provide the correct input and try again.</p>
|
|
92
96
|
*
|
|
97
|
+
* @throws {@link KendraServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
93
99
|
*
|
|
94
100
|
*/
|
|
95
101
|
export declare class CreateExperienceCommand extends $Command<CreateExperienceCommandInput, CreateExperienceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -50,6 +50,10 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
|
|
|
50
50
|
* };
|
|
51
51
|
* const command = new CreateFaqCommand(input);
|
|
52
52
|
* const response = await client.send(command);
|
|
53
|
+
* // { // CreateFaqResponse
|
|
54
|
+
* // Id: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
53
57
|
* ```
|
|
54
58
|
*
|
|
55
59
|
* @param CreateFaqCommandInput - {@link CreateFaqCommandInput}
|
|
@@ -88,6 +92,8 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
|
|
|
88
92
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
89
93
|
* Please provide the correct input and try again.</p>
|
|
90
94
|
*
|
|
95
|
+
* @throws {@link KendraServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
91
97
|
*
|
|
92
98
|
*/
|
|
93
99
|
export declare class CreateFaqCommand extends $Command<CreateFaqCommandInput, CreateFaqCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -55,6 +55,25 @@ export interface CreateFeaturedResultsSetCommandOutput extends CreateFeaturedRes
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new CreateFeaturedResultsSetCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // { // CreateFeaturedResultsSetResponse
|
|
59
|
+
* // FeaturedResultsSet: { // FeaturedResultsSet
|
|
60
|
+
* // FeaturedResultsSetId: "STRING_VALUE",
|
|
61
|
+
* // FeaturedResultsSetName: "STRING_VALUE",
|
|
62
|
+
* // Description: "STRING_VALUE",
|
|
63
|
+
* // Status: "ACTIVE" || "INACTIVE",
|
|
64
|
+
* // QueryTexts: [ // QueryTextList
|
|
65
|
+
* // "STRING_VALUE",
|
|
66
|
+
* // ],
|
|
67
|
+
* // FeaturedDocuments: [ // FeaturedDocumentList
|
|
68
|
+
* // { // FeaturedDocument
|
|
69
|
+
* // Id: "STRING_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // LastUpdatedTimestamp: Number("long"),
|
|
73
|
+
* // CreationTimestamp: Number("long"),
|
|
74
|
+
* // },
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
58
77
|
* ```
|
|
59
78
|
*
|
|
60
79
|
* @param CreateFeaturedResultsSetCommandInput - {@link CreateFeaturedResultsSetCommandInput}
|
|
@@ -93,6 +112,8 @@ export interface CreateFeaturedResultsSetCommandOutput extends CreateFeaturedRes
|
|
|
93
112
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
94
113
|
* Please provide the correct input and try again.</p>
|
|
95
114
|
*
|
|
115
|
+
* @throws {@link KendraServiceException}
|
|
116
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
96
117
|
*
|
|
97
118
|
*/
|
|
98
119
|
export declare class CreateFeaturedResultsSetCommand extends $Command<CreateFeaturedResultsSetCommandInput, CreateFeaturedResultsSetCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -74,6 +74,10 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
|
|
|
74
74
|
* };
|
|
75
75
|
* const command = new CreateIndexCommand(input);
|
|
76
76
|
* const response = await client.send(command);
|
|
77
|
+
* // { // CreateIndexResponse
|
|
78
|
+
* // Id: "STRING_VALUE",
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
77
81
|
* ```
|
|
78
82
|
*
|
|
79
83
|
* @param CreateIndexCommandInput - {@link CreateIndexCommandInput}
|
|
@@ -112,6 +116,8 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
|
|
|
112
116
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
113
117
|
* Please provide the correct input and try again.</p>
|
|
114
118
|
*
|
|
119
|
+
* @throws {@link KendraServiceException}
|
|
120
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
115
121
|
*
|
|
116
122
|
*/
|
|
117
123
|
export declare class CreateIndexCommand extends $Command<CreateIndexCommandInput, CreateIndexCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -59,6 +59,10 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
|
|
|
59
59
|
* };
|
|
60
60
|
* const command = new CreateQuerySuggestionsBlockListCommand(input);
|
|
61
61
|
* const response = await client.send(command);
|
|
62
|
+
* // { // CreateQuerySuggestionsBlockListResponse
|
|
63
|
+
* // Id: "STRING_VALUE",
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
62
66
|
* ```
|
|
63
67
|
*
|
|
64
68
|
* @param CreateQuerySuggestionsBlockListCommandInput - {@link CreateQuerySuggestionsBlockListCommandInput}
|
|
@@ -97,6 +101,8 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
|
|
|
97
101
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
98
102
|
* Please provide the correct input and try again.</p>
|
|
99
103
|
*
|
|
104
|
+
* @throws {@link KendraServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
100
106
|
*
|
|
101
107
|
*/
|
|
102
108
|
export declare class CreateQuerySuggestionsBlockListCommand extends $Command<CreateQuerySuggestionsBlockListCommandInput, CreateQuerySuggestionsBlockListCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -49,6 +49,10 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _
|
|
|
49
49
|
* };
|
|
50
50
|
* const command = new CreateThesaurusCommand(input);
|
|
51
51
|
* const response = await client.send(command);
|
|
52
|
+
* // { // CreateThesaurusResponse
|
|
53
|
+
* // Id: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
52
56
|
* ```
|
|
53
57
|
*
|
|
54
58
|
* @param CreateThesaurusCommandInput - {@link CreateThesaurusCommandInput}
|
|
@@ -87,6 +91,8 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _
|
|
|
87
91
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
88
92
|
* Please provide the correct input and try again.</p>
|
|
89
93
|
*
|
|
94
|
+
* @throws {@link KendraServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
90
96
|
*
|
|
91
97
|
*/
|
|
92
98
|
export declare class CreateThesaurusCommand extends $Command<CreateThesaurusCommandInput, CreateThesaurusCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -35,6 +35,8 @@ export interface DeleteAccessControlConfigurationCommandOutput extends DeleteAcc
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DeleteAccessControlConfigurationCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // {};
|
|
39
|
+
*
|
|
38
40
|
* ```
|
|
39
41
|
*
|
|
40
42
|
* @param DeleteAccessControlConfigurationCommandInput - {@link DeleteAccessControlConfigurationCommandInput}
|
|
@@ -67,6 +69,8 @@ export interface DeleteAccessControlConfigurationCommandOutput extends DeleteAcc
|
|
|
67
69
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
68
70
|
* Please provide the correct input and try again.</p>
|
|
69
71
|
*
|
|
72
|
+
* @throws {@link KendraServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
70
74
|
*
|
|
71
75
|
*/
|
|
72
76
|
export declare class DeleteAccessControlConfigurationCommand extends $Command<DeleteAccessControlConfigurationCommandInput, DeleteAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -35,6 +35,8 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DeleteDataSourceCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // {};
|
|
39
|
+
*
|
|
38
40
|
* ```
|
|
39
41
|
*
|
|
40
42
|
* @param DeleteDataSourceCommandInput - {@link DeleteDataSourceCommandInput}
|
|
@@ -67,6 +69,8 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {
|
|
|
67
69
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
68
70
|
* Please provide the correct input and try again.</p>
|
|
69
71
|
*
|
|
72
|
+
* @throws {@link KendraServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
70
74
|
*
|
|
71
75
|
*/
|
|
72
76
|
export declare class DeleteDataSourceCommand extends $Command<DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -34,6 +34,8 @@ export interface DeleteExperienceCommandOutput extends DeleteExperienceResponse,
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DeleteExperienceCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param DeleteExperienceCommandInput - {@link DeleteExperienceCommandInput}
|
|
@@ -66,6 +68,8 @@ export interface DeleteExperienceCommandOutput extends DeleteExperienceResponse,
|
|
|
66
68
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
67
69
|
* Please provide the correct input and try again.</p>
|
|
68
70
|
*
|
|
71
|
+
* @throws {@link KendraServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
69
73
|
*
|
|
70
74
|
*/
|
|
71
75
|
export declare class DeleteExperienceCommand extends $Command<DeleteExperienceCommandInput, DeleteExperienceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -32,6 +32,8 @@ export interface DeleteFaqCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteFaqCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // {};
|
|
36
|
+
*
|
|
35
37
|
* ```
|
|
36
38
|
*
|
|
37
39
|
* @param DeleteFaqCommandInput - {@link DeleteFaqCommandInput}
|
|
@@ -64,6 +66,8 @@ export interface DeleteFaqCommandOutput extends __MetadataBearer {
|
|
|
64
66
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
65
67
|
* Please provide the correct input and try again.</p>
|
|
66
68
|
*
|
|
69
|
+
* @throws {@link KendraServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
67
71
|
*
|
|
68
72
|
*/
|
|
69
73
|
export declare class DeleteFaqCommand extends $Command<DeleteFaqCommandInput, DeleteFaqCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -34,6 +34,8 @@ export interface DeleteIndexCommandOutput extends __MetadataBearer {
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DeleteIndexCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param DeleteIndexCommandInput - {@link DeleteIndexCommandInput}
|
|
@@ -66,6 +68,8 @@ export interface DeleteIndexCommandOutput extends __MetadataBearer {
|
|
|
66
68
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
67
69
|
* Please provide the correct input and try again.</p>
|
|
68
70
|
*
|
|
71
|
+
* @throws {@link KendraServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
69
73
|
*
|
|
70
74
|
*/
|
|
71
75
|
export declare class DeleteIndexCommand extends $Command<DeleteIndexCommandInput, DeleteIndexCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -46,6 +46,8 @@ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {
|
|
|
46
46
|
* };
|
|
47
47
|
* const command = new DeletePrincipalMappingCommand(input);
|
|
48
48
|
* const response = await client.send(command);
|
|
49
|
+
* // {};
|
|
50
|
+
*
|
|
49
51
|
* ```
|
|
50
52
|
*
|
|
51
53
|
* @param DeletePrincipalMappingCommandInput - {@link DeletePrincipalMappingCommandInput}
|
|
@@ -78,6 +80,8 @@ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {
|
|
|
78
80
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
79
81
|
* Please provide the correct input and try again.</p>
|
|
80
82
|
*
|
|
83
|
+
* @throws {@link KendraServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
81
85
|
*
|
|
82
86
|
*/
|
|
83
87
|
export declare class DeletePrincipalMappingCommand extends $Command<DeletePrincipalMappingCommandInput, DeletePrincipalMappingCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -38,6 +38,8 @@ export interface DeleteQuerySuggestionsBlockListCommandOutput extends __Metadata
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DeleteQuerySuggestionsBlockListCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
41
43
|
* ```
|
|
42
44
|
*
|
|
43
45
|
* @param DeleteQuerySuggestionsBlockListCommandInput - {@link DeleteQuerySuggestionsBlockListCommandInput}
|
|
@@ -70,6 +72,8 @@ export interface DeleteQuerySuggestionsBlockListCommandOutput extends __Metadata
|
|
|
70
72
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
71
73
|
* Please provide the correct input and try again.</p>
|
|
72
74
|
*
|
|
75
|
+
* @throws {@link KendraServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
73
77
|
*
|
|
74
78
|
*/
|
|
75
79
|
export declare class DeleteQuerySuggestionsBlockListCommand extends $Command<DeleteQuerySuggestionsBlockListCommandInput, DeleteQuerySuggestionsBlockListCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -33,6 +33,8 @@ export interface DeleteThesaurusCommandOutput extends __MetadataBearer {
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new DeleteThesaurusCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // {};
|
|
37
|
+
*
|
|
36
38
|
* ```
|
|
37
39
|
*
|
|
38
40
|
* @param DeleteThesaurusCommandInput - {@link DeleteThesaurusCommandInput}
|
|
@@ -65,6 +67,8 @@ export interface DeleteThesaurusCommandOutput extends __MetadataBearer {
|
|
|
65
67
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
66
68
|
* Please provide the correct input and try again.</p>
|
|
67
69
|
*
|
|
70
|
+
* @throws {@link KendraServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
68
72
|
*
|
|
69
73
|
*/
|
|
70
74
|
export declare class DeleteThesaurusCommand extends $Command<DeleteThesaurusCommandInput, DeleteThesaurusCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -35,6 +35,32 @@ export interface DescribeAccessControlConfigurationCommandOutput extends Describ
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DescribeAccessControlConfigurationCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // DescribeAccessControlConfigurationResponse
|
|
39
|
+
* // Name: "STRING_VALUE", // required
|
|
40
|
+
* // Description: "STRING_VALUE",
|
|
41
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
42
|
+
* // AccessControlList: [ // PrincipalList
|
|
43
|
+
* // { // Principal
|
|
44
|
+
* // Name: "STRING_VALUE", // required
|
|
45
|
+
* // Type: "USER" || "GROUP", // required
|
|
46
|
+
* // Access: "ALLOW" || "DENY", // required
|
|
47
|
+
* // DataSourceId: "STRING_VALUE",
|
|
48
|
+
* // },
|
|
49
|
+
* // ],
|
|
50
|
+
* // HierarchicalAccessControlList: [ // HierarchicalPrincipalList
|
|
51
|
+
* // { // HierarchicalPrincipal
|
|
52
|
+
* // PrincipalList: [ // required
|
|
53
|
+
* // {
|
|
54
|
+
* // Name: "STRING_VALUE", // required
|
|
55
|
+
* // Type: "USER" || "GROUP", // required
|
|
56
|
+
* // Access: "ALLOW" || "DENY", // required
|
|
57
|
+
* // DataSourceId: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
38
64
|
* ```
|
|
39
65
|
*
|
|
40
66
|
* @param DescribeAccessControlConfigurationCommandInput - {@link DescribeAccessControlConfigurationCommandInput}
|
|
@@ -63,6 +89,8 @@ export interface DescribeAccessControlConfigurationCommandOutput extends Describ
|
|
|
63
89
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
64
90
|
* Please provide the correct input and try again.</p>
|
|
65
91
|
*
|
|
92
|
+
* @throws {@link KendraServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
66
94
|
*
|
|
67
95
|
*/
|
|
68
96
|
export declare class DescribeAccessControlConfigurationCommand extends $Command<DescribeAccessControlConfigurationCommandInput, DescribeAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
|