@aws-sdk/client-kendra 3.321.1 → 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-cjs/models/models_0.js +10 -5
- package/dist-cjs/models/models_1.js +4 -1
- package/dist-cjs/protocols/Aws_json1_1.js +56 -2
- package/dist-es/models/models_0.js +8 -3
- package/dist-es/models/models_1.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +56 -2
- 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 +7 -1
- 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 +129 -1
- 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 +14 -1
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +173 -210
- package/dist-types/models/models_1.d.ts +213 -2
- package/dist-types/ts3.4/commands/GetQuerySuggestionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/models/models_0.d.ts +40 -46
- package/dist-types/ts3.4/models/models_1.d.ts +53 -3
- package/package.json +16 -16
|
@@ -37,6 +37,23 @@ export interface ListExperienceEntitiesCommandOutput extends ListExperienceEntit
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new ListExperienceEntitiesCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // ListExperienceEntitiesResponse
|
|
41
|
+
* // SummaryItems: [ // ExperienceEntitiesSummaryList
|
|
42
|
+
* // { // ExperienceEntitiesSummary
|
|
43
|
+
* // EntityId: "STRING_VALUE",
|
|
44
|
+
* // EntityType: "USER" || "GROUP",
|
|
45
|
+
* // DisplayData: { // EntityDisplayData
|
|
46
|
+
* // UserName: "STRING_VALUE",
|
|
47
|
+
* // GroupName: "STRING_VALUE",
|
|
48
|
+
* // IdentifiedUserName: "STRING_VALUE",
|
|
49
|
+
* // FirstName: "STRING_VALUE",
|
|
50
|
+
* // LastName: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // NextToken: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
40
57
|
* ```
|
|
41
58
|
*
|
|
42
59
|
* @param ListExperienceEntitiesCommandInput - {@link ListExperienceEntitiesCommandInput}
|
|
@@ -65,6 +82,8 @@ export interface ListExperienceEntitiesCommandOutput extends ListExperienceEntit
|
|
|
65
82
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
66
83
|
* Please provide the correct input and try again.</p>
|
|
67
84
|
*
|
|
85
|
+
* @throws {@link KendraServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
68
87
|
*
|
|
69
88
|
*/
|
|
70
89
|
export declare class ListExperienceEntitiesCommand extends $Command<ListExperienceEntitiesCommandInput, ListExperienceEntitiesCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -36,6 +36,24 @@ export interface ListExperiencesCommandOutput extends ListExperiencesResponse, _
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new ListExperiencesCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // ListExperiencesResponse
|
|
40
|
+
* // SummaryItems: [ // ExperiencesSummaryList
|
|
41
|
+
* // { // ExperiencesSummary
|
|
42
|
+
* // Name: "STRING_VALUE",
|
|
43
|
+
* // Id: "STRING_VALUE",
|
|
44
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
45
|
+
* // Status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED",
|
|
46
|
+
* // Endpoints: [ // ExperienceEndpoints
|
|
47
|
+
* // { // ExperienceEndpoint
|
|
48
|
+
* // EndpointType: "HOME",
|
|
49
|
+
* // Endpoint: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // NextToken: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
39
57
|
* ```
|
|
40
58
|
*
|
|
41
59
|
* @param ListExperiencesCommandInput - {@link ListExperiencesCommandInput}
|
|
@@ -64,6 +82,8 @@ export interface ListExperiencesCommandOutput extends ListExperiencesResponse, _
|
|
|
64
82
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
65
83
|
* Please provide the correct input and try again.</p>
|
|
66
84
|
*
|
|
85
|
+
* @throws {@link KendraServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
67
87
|
*
|
|
68
88
|
*/
|
|
69
89
|
export declare class ListExperiencesCommand extends $Command<ListExperiencesCommandInput, ListExperiencesCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -33,6 +33,21 @@ export interface ListFaqsCommandOutput extends ListFaqsResponse, __MetadataBeare
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListFaqsCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListFaqsResponse
|
|
37
|
+
* // NextToken: "STRING_VALUE",
|
|
38
|
+
* // FaqSummaryItems: [ // FaqSummaryItems
|
|
39
|
+
* // { // FaqSummary
|
|
40
|
+
* // Id: "STRING_VALUE",
|
|
41
|
+
* // Name: "STRING_VALUE",
|
|
42
|
+
* // Status: "CREATING" || "UPDATING" || "ACTIVE" || "DELETING" || "FAILED",
|
|
43
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
44
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
45
|
+
* // FileFormat: "CSV" || "CSV_WITH_HEADER" || "JSON",
|
|
46
|
+
* // LanguageCode: "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // ],
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
36
51
|
* ```
|
|
37
52
|
*
|
|
38
53
|
* @param ListFaqsCommandInput - {@link ListFaqsCommandInput}
|
|
@@ -61,6 +76,8 @@ export interface ListFaqsCommandOutput extends ListFaqsResponse, __MetadataBeare
|
|
|
61
76
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
62
77
|
* Please provide the correct input and try again.</p>
|
|
63
78
|
*
|
|
79
|
+
* @throws {@link KendraServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
64
81
|
*
|
|
65
82
|
*/
|
|
66
83
|
export declare class ListFaqsCommand extends $Command<ListFaqsCommandInput, ListFaqsCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -35,6 +35,19 @@ export interface ListFeaturedResultsSetsCommandOutput extends ListFeaturedResult
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new ListFeaturedResultsSetsCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // ListFeaturedResultsSetsResponse
|
|
39
|
+
* // FeaturedResultsSetSummaryItems: [ // FeaturedResultsSetSummaryItems
|
|
40
|
+
* // { // FeaturedResultsSetSummary
|
|
41
|
+
* // FeaturedResultsSetId: "STRING_VALUE",
|
|
42
|
+
* // FeaturedResultsSetName: "STRING_VALUE",
|
|
43
|
+
* // Status: "ACTIVE" || "INACTIVE",
|
|
44
|
+
* // LastUpdatedTimestamp: Number("long"),
|
|
45
|
+
* // CreationTimestamp: Number("long"),
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // NextToken: "STRING_VALUE",
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
38
51
|
* ```
|
|
39
52
|
*
|
|
40
53
|
* @param ListFeaturedResultsSetsCommandInput - {@link ListFeaturedResultsSetsCommandInput}
|
|
@@ -63,6 +76,8 @@ export interface ListFeaturedResultsSetsCommandOutput extends ListFeaturedResult
|
|
|
63
76
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
64
77
|
* Please provide the correct input and try again.</p>
|
|
65
78
|
*
|
|
79
|
+
* @throws {@link KendraServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
66
81
|
*
|
|
67
82
|
*/
|
|
68
83
|
export declare class ListFeaturedResultsSetsCommand extends $Command<ListFeaturedResultsSetsCommandInput, ListFeaturedResultsSetsCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -38,6 +38,16 @@ export interface ListGroupsOlderThanOrderingIdCommandOutput extends ListGroupsOl
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new ListGroupsOlderThanOrderingIdCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // ListGroupsOlderThanOrderingIdResponse
|
|
42
|
+
* // GroupsSummaries: [ // ListOfGroupSummaries
|
|
43
|
+
* // { // GroupSummary
|
|
44
|
+
* // GroupId: "STRING_VALUE",
|
|
45
|
+
* // OrderingId: Number("long"),
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // NextToken: "STRING_VALUE",
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
41
51
|
* ```
|
|
42
52
|
*
|
|
43
53
|
* @param ListGroupsOlderThanOrderingIdCommandInput - {@link ListGroupsOlderThanOrderingIdCommandInput}
|
|
@@ -70,6 +80,8 @@ export interface ListGroupsOlderThanOrderingIdCommandOutput extends ListGroupsOl
|
|
|
70
80
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
71
81
|
* Please provide the correct input and try again.</p>
|
|
72
82
|
*
|
|
83
|
+
* @throws {@link KendraServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
73
85
|
*
|
|
74
86
|
*/
|
|
75
87
|
export declare class ListGroupsOlderThanOrderingIdCommand extends $Command<ListGroupsOlderThanOrderingIdCommandInput, ListGroupsOlderThanOrderingIdCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -32,6 +32,20 @@ export interface ListIndicesCommandOutput extends ListIndicesResponse, __Metadat
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new ListIndicesCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // ListIndicesResponse
|
|
36
|
+
* // IndexConfigurationSummaryItems: [ // IndexConfigurationSummaryList
|
|
37
|
+
* // { // IndexConfigurationSummary
|
|
38
|
+
* // Name: "STRING_VALUE",
|
|
39
|
+
* // Id: "STRING_VALUE",
|
|
40
|
+
* // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
|
|
41
|
+
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
42
|
+
* // UpdatedAt: new Date("TIMESTAMP"), // required
|
|
43
|
+
* // Status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING" || "SYSTEM_UPDATING", // required
|
|
44
|
+
* // },
|
|
45
|
+
* // ],
|
|
46
|
+
* // NextToken: "STRING_VALUE",
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
35
49
|
* ```
|
|
36
50
|
*
|
|
37
51
|
* @param ListIndicesCommandInput - {@link ListIndicesCommandInput}
|
|
@@ -56,6 +70,8 @@ export interface ListIndicesCommandOutput extends ListIndicesResponse, __Metadat
|
|
|
56
70
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
57
71
|
* Please provide the correct input and try again.</p>
|
|
58
72
|
*
|
|
73
|
+
* @throws {@link KendraServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
59
75
|
*
|
|
60
76
|
*/
|
|
61
77
|
export declare class ListIndicesCommand extends $Command<ListIndicesCommandInput, ListIndicesCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -39,6 +39,20 @@ export interface ListQuerySuggestionsBlockListsCommandOutput extends ListQuerySu
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new ListQuerySuggestionsBlockListsCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // ListQuerySuggestionsBlockListsResponse
|
|
43
|
+
* // BlockListSummaryItems: [ // QuerySuggestionsBlockListSummaryItems
|
|
44
|
+
* // { // QuerySuggestionsBlockListSummary
|
|
45
|
+
* // Id: "STRING_VALUE",
|
|
46
|
+
* // Name: "STRING_VALUE",
|
|
47
|
+
* // Status: "ACTIVE" || "CREATING" || "DELETING" || "UPDATING" || "ACTIVE_BUT_UPDATE_FAILED" || "FAILED",
|
|
48
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
49
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
50
|
+
* // ItemCount: Number("int"),
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // NextToken: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
42
56
|
* ```
|
|
43
57
|
*
|
|
44
58
|
* @param ListQuerySuggestionsBlockListsCommandInput - {@link ListQuerySuggestionsBlockListsCommandInput}
|
|
@@ -67,6 +81,8 @@ export interface ListQuerySuggestionsBlockListsCommandOutput extends ListQuerySu
|
|
|
67
81
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
68
82
|
* Please provide the correct input and try again.</p>
|
|
69
83
|
*
|
|
84
|
+
* @throws {@link KendraServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
70
86
|
*
|
|
71
87
|
*/
|
|
72
88
|
export declare class ListQuerySuggestionsBlockListsCommand extends $Command<ListQuerySuggestionsBlockListsCommandInput, ListQuerySuggestionsBlockListsCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -32,6 +32,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new ListTagsForResourceCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // ListTagsForResourceResponse
|
|
36
|
+
* // Tags: [ // TagList
|
|
37
|
+
* // { // Tag
|
|
38
|
+
* // Key: "STRING_VALUE", // required
|
|
39
|
+
* // Value: "STRING_VALUE", // required
|
|
40
|
+
* // },
|
|
41
|
+
* // ],
|
|
42
|
+
* // };
|
|
43
|
+
*
|
|
35
44
|
* ```
|
|
36
45
|
*
|
|
37
46
|
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
@@ -60,6 +69,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
60
69
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
61
70
|
* Please provide the correct input and try again.</p>
|
|
62
71
|
*
|
|
72
|
+
* @throws {@link KendraServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
63
74
|
*
|
|
64
75
|
*/
|
|
65
76
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -33,6 +33,19 @@ export interface ListThesauriCommandOutput extends ListThesauriResponse, __Metad
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListThesauriCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListThesauriResponse
|
|
37
|
+
* // NextToken: "STRING_VALUE",
|
|
38
|
+
* // ThesaurusSummaryItems: [ // ThesaurusSummaryItems
|
|
39
|
+
* // { // ThesaurusSummary
|
|
40
|
+
* // Id: "STRING_VALUE",
|
|
41
|
+
* // Name: "STRING_VALUE",
|
|
42
|
+
* // Status: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING" || "ACTIVE_BUT_UPDATE_FAILED" || "FAILED",
|
|
43
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
44
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
45
|
+
* // },
|
|
46
|
+
* // ],
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
36
49
|
* ```
|
|
37
50
|
*
|
|
38
51
|
* @param ListThesauriCommandInput - {@link ListThesauriCommandInput}
|
|
@@ -61,6 +74,8 @@ export interface ListThesauriCommandOutput extends ListThesauriResponse, __Metad
|
|
|
61
74
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
62
75
|
* Please provide the correct input and try again.</p>
|
|
63
76
|
*
|
|
77
|
+
* @throws {@link KendraServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
64
79
|
*
|
|
65
80
|
*/
|
|
66
81
|
export declare class ListThesauriCommand extends $Command<ListThesauriCommandInput, ListThesauriCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -63,6 +63,8 @@ export interface PutPrincipalMappingCommandOutput extends __MetadataBearer {
|
|
|
63
63
|
* };
|
|
64
64
|
* const command = new PutPrincipalMappingCommand(input);
|
|
65
65
|
* const response = await client.send(command);
|
|
66
|
+
* // {};
|
|
67
|
+
*
|
|
66
68
|
* ```
|
|
67
69
|
*
|
|
68
70
|
* @param PutPrincipalMappingCommandInput - {@link PutPrincipalMappingCommandInput}
|
|
@@ -101,6 +103,8 @@ export interface PutPrincipalMappingCommandOutput extends __MetadataBearer {
|
|
|
101
103
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
102
104
|
* Please provide the correct input and try again.</p>
|
|
103
105
|
*
|
|
106
|
+
* @throws {@link KendraServiceException}
|
|
107
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
104
108
|
*
|
|
105
109
|
*/
|
|
106
110
|
export declare class PutPrincipalMappingCommand extends $Command<PutPrincipalMappingCommandInput, PutPrincipalMappingCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -187,6 +187,204 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
|
|
|
187
187
|
* };
|
|
188
188
|
* const command = new QueryCommand(input);
|
|
189
189
|
* const response = await client.send(command);
|
|
190
|
+
* // { // QueryResult
|
|
191
|
+
* // QueryId: "STRING_VALUE",
|
|
192
|
+
* // ResultItems: [ // QueryResultItemList
|
|
193
|
+
* // { // QueryResultItem
|
|
194
|
+
* // Id: "STRING_VALUE",
|
|
195
|
+
* // Type: "DOCUMENT" || "QUESTION_ANSWER" || "ANSWER",
|
|
196
|
+
* // Format: "TABLE" || "TEXT",
|
|
197
|
+
* // AdditionalAttributes: [ // AdditionalResultAttributeList
|
|
198
|
+
* // { // AdditionalResultAttribute
|
|
199
|
+
* // Key: "STRING_VALUE", // required
|
|
200
|
+
* // ValueType: "TEXT_WITH_HIGHLIGHTS_VALUE", // required
|
|
201
|
+
* // Value: { // AdditionalResultAttributeValue
|
|
202
|
+
* // TextWithHighlightsValue: { // TextWithHighlights
|
|
203
|
+
* // Text: "STRING_VALUE",
|
|
204
|
+
* // Highlights: [ // HighlightList
|
|
205
|
+
* // { // Highlight
|
|
206
|
+
* // BeginOffset: Number("int"), // required
|
|
207
|
+
* // EndOffset: Number("int"), // required
|
|
208
|
+
* // TopAnswer: true || false,
|
|
209
|
+
* // Type: "STANDARD" || "THESAURUS_SYNONYM",
|
|
210
|
+
* // },
|
|
211
|
+
* // ],
|
|
212
|
+
* // },
|
|
213
|
+
* // },
|
|
214
|
+
* // },
|
|
215
|
+
* // ],
|
|
216
|
+
* // DocumentId: "STRING_VALUE",
|
|
217
|
+
* // DocumentTitle: {
|
|
218
|
+
* // Text: "STRING_VALUE",
|
|
219
|
+
* // Highlights: [
|
|
220
|
+
* // {
|
|
221
|
+
* // BeginOffset: Number("int"), // required
|
|
222
|
+
* // EndOffset: Number("int"), // required
|
|
223
|
+
* // TopAnswer: true || false,
|
|
224
|
+
* // Type: "STANDARD" || "THESAURUS_SYNONYM",
|
|
225
|
+
* // },
|
|
226
|
+
* // ],
|
|
227
|
+
* // },
|
|
228
|
+
* // DocumentExcerpt: {
|
|
229
|
+
* // Text: "STRING_VALUE",
|
|
230
|
+
* // Highlights: [
|
|
231
|
+
* // {
|
|
232
|
+
* // BeginOffset: Number("int"), // required
|
|
233
|
+
* // EndOffset: Number("int"), // required
|
|
234
|
+
* // TopAnswer: true || false,
|
|
235
|
+
* // Type: "STANDARD" || "THESAURUS_SYNONYM",
|
|
236
|
+
* // },
|
|
237
|
+
* // ],
|
|
238
|
+
* // },
|
|
239
|
+
* // DocumentURI: "STRING_VALUE",
|
|
240
|
+
* // DocumentAttributes: [ // DocumentAttributeList
|
|
241
|
+
* // { // DocumentAttribute
|
|
242
|
+
* // Key: "STRING_VALUE", // required
|
|
243
|
+
* // Value: { // DocumentAttributeValue
|
|
244
|
+
* // StringValue: "STRING_VALUE",
|
|
245
|
+
* // StringListValue: [ // DocumentAttributeStringListValue
|
|
246
|
+
* // "STRING_VALUE",
|
|
247
|
+
* // ],
|
|
248
|
+
* // LongValue: Number("long"),
|
|
249
|
+
* // DateValue: new Date("TIMESTAMP"),
|
|
250
|
+
* // },
|
|
251
|
+
* // },
|
|
252
|
+
* // ],
|
|
253
|
+
* // ScoreAttributes: { // ScoreAttributes
|
|
254
|
+
* // ScoreConfidence: "VERY_HIGH" || "HIGH" || "MEDIUM" || "LOW" || "NOT_AVAILABLE",
|
|
255
|
+
* // },
|
|
256
|
+
* // FeedbackToken: "STRING_VALUE",
|
|
257
|
+
* // TableExcerpt: { // TableExcerpt
|
|
258
|
+
* // Rows: [ // TableRowList
|
|
259
|
+
* // { // TableRow
|
|
260
|
+
* // Cells: [ // TableCellList
|
|
261
|
+
* // { // TableCell
|
|
262
|
+
* // Value: "STRING_VALUE",
|
|
263
|
+
* // TopAnswer: true || false,
|
|
264
|
+
* // Highlighted: true || false,
|
|
265
|
+
* // Header: true || false,
|
|
266
|
+
* // },
|
|
267
|
+
* // ],
|
|
268
|
+
* // },
|
|
269
|
+
* // ],
|
|
270
|
+
* // TotalNumberOfRows: Number("int"),
|
|
271
|
+
* // },
|
|
272
|
+
* // },
|
|
273
|
+
* // ],
|
|
274
|
+
* // FacetResults: [ // FacetResultList
|
|
275
|
+
* // { // FacetResult
|
|
276
|
+
* // DocumentAttributeKey: "STRING_VALUE",
|
|
277
|
+
* // DocumentAttributeValueType: "STRING_VALUE" || "STRING_LIST_VALUE" || "LONG_VALUE" || "DATE_VALUE",
|
|
278
|
+
* // DocumentAttributeValueCountPairs: [ // DocumentAttributeValueCountPairList
|
|
279
|
+
* // { // DocumentAttributeValueCountPair
|
|
280
|
+
* // DocumentAttributeValue: {
|
|
281
|
+
* // StringValue: "STRING_VALUE",
|
|
282
|
+
* // StringListValue: [
|
|
283
|
+
* // "STRING_VALUE",
|
|
284
|
+
* // ],
|
|
285
|
+
* // LongValue: Number("long"),
|
|
286
|
+
* // DateValue: new Date("TIMESTAMP"),
|
|
287
|
+
* // },
|
|
288
|
+
* // Count: Number("int"),
|
|
289
|
+
* // FacetResults: [
|
|
290
|
+
* // {
|
|
291
|
+
* // DocumentAttributeKey: "STRING_VALUE",
|
|
292
|
+
* // DocumentAttributeValueType: "STRING_VALUE" || "STRING_LIST_VALUE" || "LONG_VALUE" || "DATE_VALUE",
|
|
293
|
+
* // DocumentAttributeValueCountPairs: [
|
|
294
|
+
* // {
|
|
295
|
+
* // DocumentAttributeValue: {
|
|
296
|
+
* // StringValue: "STRING_VALUE",
|
|
297
|
+
* // StringListValue: [
|
|
298
|
+
* // "STRING_VALUE",
|
|
299
|
+
* // ],
|
|
300
|
+
* // LongValue: Number("long"),
|
|
301
|
+
* // DateValue: new Date("TIMESTAMP"),
|
|
302
|
+
* // },
|
|
303
|
+
* // Count: Number("int"),
|
|
304
|
+
* // FacetResults: "<FacetResultList>",
|
|
305
|
+
* // },
|
|
306
|
+
* // ],
|
|
307
|
+
* // },
|
|
308
|
+
* // ],
|
|
309
|
+
* // },
|
|
310
|
+
* // ],
|
|
311
|
+
* // },
|
|
312
|
+
* // ],
|
|
313
|
+
* // TotalNumberOfResults: Number("int"),
|
|
314
|
+
* // Warnings: [ // WarningList
|
|
315
|
+
* // { // Warning
|
|
316
|
+
* // Message: "STRING_VALUE",
|
|
317
|
+
* // Code: "QUERY_LANGUAGE_INVALID_SYNTAX",
|
|
318
|
+
* // },
|
|
319
|
+
* // ],
|
|
320
|
+
* // SpellCorrectedQueries: [ // SpellCorrectedQueryList
|
|
321
|
+
* // { // SpellCorrectedQuery
|
|
322
|
+
* // SuggestedQueryText: "STRING_VALUE",
|
|
323
|
+
* // Corrections: [ // CorrectionList
|
|
324
|
+
* // { // Correction
|
|
325
|
+
* // BeginOffset: Number("int"),
|
|
326
|
+
* // EndOffset: Number("int"),
|
|
327
|
+
* // Term: "STRING_VALUE",
|
|
328
|
+
* // CorrectedTerm: "STRING_VALUE",
|
|
329
|
+
* // },
|
|
330
|
+
* // ],
|
|
331
|
+
* // },
|
|
332
|
+
* // ],
|
|
333
|
+
* // FeaturedResultsItems: [ // FeaturedResultsItemList
|
|
334
|
+
* // { // FeaturedResultsItem
|
|
335
|
+
* // Id: "STRING_VALUE",
|
|
336
|
+
* // Type: "DOCUMENT" || "QUESTION_ANSWER" || "ANSWER",
|
|
337
|
+
* // AdditionalAttributes: [
|
|
338
|
+
* // {
|
|
339
|
+
* // Key: "STRING_VALUE", // required
|
|
340
|
+
* // ValueType: "TEXT_WITH_HIGHLIGHTS_VALUE", // required
|
|
341
|
+
* // Value: {
|
|
342
|
+
* // TextWithHighlightsValue: {
|
|
343
|
+
* // Text: "STRING_VALUE",
|
|
344
|
+
* // Highlights: [
|
|
345
|
+
* // {
|
|
346
|
+
* // BeginOffset: Number("int"), // required
|
|
347
|
+
* // EndOffset: Number("int"), // required
|
|
348
|
+
* // TopAnswer: true || false,
|
|
349
|
+
* // Type: "STANDARD" || "THESAURUS_SYNONYM",
|
|
350
|
+
* // },
|
|
351
|
+
* // ],
|
|
352
|
+
* // },
|
|
353
|
+
* // },
|
|
354
|
+
* // },
|
|
355
|
+
* // ],
|
|
356
|
+
* // DocumentId: "STRING_VALUE",
|
|
357
|
+
* // DocumentTitle: {
|
|
358
|
+
* // Text: "STRING_VALUE",
|
|
359
|
+
* // Highlights: [
|
|
360
|
+
* // {
|
|
361
|
+
* // BeginOffset: Number("int"), // required
|
|
362
|
+
* // EndOffset: Number("int"), // required
|
|
363
|
+
* // TopAnswer: true || false,
|
|
364
|
+
* // Type: "STANDARD" || "THESAURUS_SYNONYM",
|
|
365
|
+
* // },
|
|
366
|
+
* // ],
|
|
367
|
+
* // },
|
|
368
|
+
* // DocumentExcerpt: "<TextWithHighlights>",
|
|
369
|
+
* // DocumentURI: "STRING_VALUE",
|
|
370
|
+
* // DocumentAttributes: [
|
|
371
|
+
* // {
|
|
372
|
+
* // Key: "STRING_VALUE", // required
|
|
373
|
+
* // Value: {
|
|
374
|
+
* // StringValue: "STRING_VALUE",
|
|
375
|
+
* // StringListValue: [
|
|
376
|
+
* // "STRING_VALUE",
|
|
377
|
+
* // ],
|
|
378
|
+
* // LongValue: Number("long"),
|
|
379
|
+
* // DateValue: new Date("TIMESTAMP"),
|
|
380
|
+
* // },
|
|
381
|
+
* // },
|
|
382
|
+
* // ],
|
|
383
|
+
* // FeedbackToken: "STRING_VALUE",
|
|
384
|
+
* // },
|
|
385
|
+
* // ],
|
|
386
|
+
* // };
|
|
387
|
+
*
|
|
190
388
|
* ```
|
|
191
389
|
*
|
|
192
390
|
* @param QueryCommandInput - {@link QueryCommandInput}
|
|
@@ -225,6 +423,8 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
|
|
|
225
423
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
226
424
|
* Please provide the correct input and try again.</p>
|
|
227
425
|
*
|
|
426
|
+
* @throws {@link KendraServiceException}
|
|
427
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
228
428
|
*
|
|
229
429
|
*/
|
|
230
430
|
export declare class QueryCommand extends $Command<QueryCommandInput, QueryCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -34,6 +34,10 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new StartDataSourceSyncJobCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // StartDataSourceSyncJobResponse
|
|
38
|
+
* // ExecutionId: "STRING_VALUE",
|
|
39
|
+
* // };
|
|
40
|
+
*
|
|
37
41
|
* ```
|
|
38
42
|
*
|
|
39
43
|
* @param StartDataSourceSyncJobCommandInput - {@link StartDataSourceSyncJobCommandInput}
|
|
@@ -70,6 +74,8 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync
|
|
|
70
74
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
71
75
|
* Please provide the correct input and try again.</p>
|
|
72
76
|
*
|
|
77
|
+
* @throws {@link KendraServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
73
79
|
*
|
|
74
80
|
*/
|
|
75
81
|
export declare class StartDataSourceSyncJobCommand extends $Command<StartDataSourceSyncJobCommandInput, StartDataSourceSyncJobCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -33,6 +33,8 @@ export interface StopDataSourceSyncJobCommandOutput extends __MetadataBearer {
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new StopDataSourceSyncJobCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // {};
|
|
37
|
+
*
|
|
36
38
|
* ```
|
|
37
39
|
*
|
|
38
40
|
* @param StopDataSourceSyncJobCommandInput - {@link StopDataSourceSyncJobCommandInput}
|
|
@@ -61,6 +63,8 @@ export interface StopDataSourceSyncJobCommandOutput extends __MetadataBearer {
|
|
|
61
63
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
62
64
|
* Please provide the correct input and try again.</p>
|
|
63
65
|
*
|
|
66
|
+
* @throws {@link KendraServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
64
68
|
*
|
|
65
69
|
*/
|
|
66
70
|
export declare class StopDataSourceSyncJobCommand extends $Command<StopDataSourceSyncJobCommandInput, StopDataSourceSyncJobCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -48,6 +48,8 @@ export interface SubmitFeedbackCommandOutput extends __MetadataBearer {
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new SubmitFeedbackCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // {};
|
|
52
|
+
*
|
|
51
53
|
* ```
|
|
52
54
|
*
|
|
53
55
|
* @param SubmitFeedbackCommandInput - {@link SubmitFeedbackCommandInput}
|
|
@@ -80,6 +82,8 @@ export interface SubmitFeedbackCommandOutput extends __MetadataBearer {
|
|
|
80
82
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
81
83
|
* Please provide the correct input and try again.</p>
|
|
82
84
|
*
|
|
85
|
+
* @throws {@link KendraServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
83
87
|
*
|
|
84
88
|
*/
|
|
85
89
|
export declare class SubmitFeedbackCommand extends $Command<SubmitFeedbackCommandInput, SubmitFeedbackCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -38,6 +38,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new TagResourceCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
41
43
|
* ```
|
|
42
44
|
*
|
|
43
45
|
* @param TagResourceCommandInput - {@link TagResourceCommandInput}
|
|
@@ -66,6 +68,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
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 TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new UntagResourceCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
|
|
@@ -62,6 +64,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
62
64
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
63
65
|
* Please provide the correct input and try again.</p>
|
|
64
66
|
*
|
|
67
|
+
* @throws {@link KendraServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
65
69
|
*
|
|
66
70
|
*/
|
|
67
71
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -72,6 +72,8 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
|
|
|
72
72
|
* };
|
|
73
73
|
* const command = new UpdateAccessControlConfigurationCommand(input);
|
|
74
74
|
* const response = await client.send(command);
|
|
75
|
+
* // {};
|
|
76
|
+
*
|
|
75
77
|
* ```
|
|
76
78
|
*
|
|
77
79
|
* @param UpdateAccessControlConfigurationCommandInput - {@link UpdateAccessControlConfigurationCommandInput}
|
|
@@ -110,6 +112,8 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
|
|
|
110
112
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
111
113
|
* Please provide the correct input and try again.</p>
|
|
112
114
|
*
|
|
115
|
+
* @throws {@link KendraServiceException}
|
|
116
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
113
117
|
*
|
|
114
118
|
*/
|
|
115
119
|
export declare class UpdateAccessControlConfigurationCommand extends $Command<UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -590,6 +590,8 @@ export interface UpdateDataSourceCommandOutput extends __MetadataBearer {
|
|
|
590
590
|
* };
|
|
591
591
|
* const command = new UpdateDataSourceCommand(input);
|
|
592
592
|
* const response = await client.send(command);
|
|
593
|
+
* // {};
|
|
594
|
+
*
|
|
593
595
|
* ```
|
|
594
596
|
*
|
|
595
597
|
* @param UpdateDataSourceCommandInput - {@link UpdateDataSourceCommandInput}
|
|
@@ -622,6 +624,8 @@ export interface UpdateDataSourceCommandOutput extends __MetadataBearer {
|
|
|
622
624
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
623
625
|
* Please provide the correct input and try again.</p>
|
|
624
626
|
*
|
|
627
|
+
* @throws {@link KendraServiceException}
|
|
628
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
625
629
|
*
|
|
626
630
|
*/
|
|
627
631
|
export declare class UpdateDataSourceCommand extends $Command<UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput, KendraClientResolvedConfig> {
|
|
@@ -51,6 +51,8 @@ export interface UpdateExperienceCommandOutput extends __MetadataBearer {
|
|
|
51
51
|
* };
|
|
52
52
|
* const command = new UpdateExperienceCommand(input);
|
|
53
53
|
* const response = await client.send(command);
|
|
54
|
+
* // {};
|
|
55
|
+
*
|
|
54
56
|
* ```
|
|
55
57
|
*
|
|
56
58
|
* @param UpdateExperienceCommandInput - {@link UpdateExperienceCommandInput}
|
|
@@ -83,6 +85,8 @@ export interface UpdateExperienceCommandOutput extends __MetadataBearer {
|
|
|
83
85
|
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
84
86
|
* Please provide the correct input and try again.</p>
|
|
85
87
|
*
|
|
88
|
+
* @throws {@link KendraServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from Kendra service.</p>
|
|
86
90
|
*
|
|
87
91
|
*/
|
|
88
92
|
export declare class UpdateExperienceCommand extends $Command<UpdateExperienceCommandInput, UpdateExperienceCommandOutput, KendraClientResolvedConfig> {
|