@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.
Files changed (77) hide show
  1. package/dist-cjs/models/models_0.js +10 -5
  2. package/dist-cjs/models/models_1.js +4 -1
  3. package/dist-cjs/protocols/Aws_json1_1.js +56 -2
  4. package/dist-es/models/models_0.js +8 -3
  5. package/dist-es/models/models_1.js +3 -0
  6. package/dist-es/protocols/Aws_json1_1.js +56 -2
  7. package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +11 -0
  8. package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +11 -0
  9. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +12 -0
  10. package/dist-types/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +12 -0
  11. package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +20 -0
  12. package/dist-types/commands/BatchPutDocumentCommand.d.ts +12 -0
  13. package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +4 -0
  14. package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +6 -0
  15. package/dist-types/commands/CreateDataSourceCommand.d.ts +6 -0
  16. package/dist-types/commands/CreateExperienceCommand.d.ts +6 -0
  17. package/dist-types/commands/CreateFaqCommand.d.ts +6 -0
  18. package/dist-types/commands/CreateFeaturedResultsSetCommand.d.ts +21 -0
  19. package/dist-types/commands/CreateIndexCommand.d.ts +6 -0
  20. package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +7 -1
  21. package/dist-types/commands/CreateThesaurusCommand.d.ts +6 -0
  22. package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteDataSourceCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteExperienceCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteFaqCommand.d.ts +4 -0
  26. package/dist-types/commands/DeleteIndexCommand.d.ts +4 -0
  27. package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +4 -0
  28. package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +4 -0
  29. package/dist-types/commands/DeleteThesaurusCommand.d.ts +4 -0
  30. package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +28 -0
  31. package/dist-types/commands/DescribeDataSourceCommand.d.ts +570 -0
  32. package/dist-types/commands/DescribeExperienceCommand.d.ts +34 -0
  33. package/dist-types/commands/DescribeFaqCommand.d.ts +20 -0
  34. package/dist-types/commands/DescribeFeaturedResultsSetCommand.d.ts +26 -0
  35. package/dist-types/commands/DescribeIndexCommand.d.ts +72 -0
  36. package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +17 -0
  37. package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +20 -0
  38. package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +14 -0
  39. package/dist-types/commands/DescribeThesaurusCommand.d.ts +21 -0
  40. package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +11 -0
  41. package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +11 -0
  42. package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +129 -1
  43. package/dist-types/commands/GetSnapshotsCommand.d.ts +18 -0
  44. package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +11 -0
  45. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +24 -0
  46. package/dist-types/commands/ListDataSourcesCommand.d.ts +17 -0
  47. package/dist-types/commands/ListEntityPersonasCommand.d.ts +14 -0
  48. package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +19 -0
  49. package/dist-types/commands/ListExperiencesCommand.d.ts +20 -0
  50. package/dist-types/commands/ListFaqsCommand.d.ts +17 -0
  51. package/dist-types/commands/ListFeaturedResultsSetsCommand.d.ts +15 -0
  52. package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +12 -0
  53. package/dist-types/commands/ListIndicesCommand.d.ts +16 -0
  54. package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  56. package/dist-types/commands/ListThesauriCommand.d.ts +15 -0
  57. package/dist-types/commands/PutPrincipalMappingCommand.d.ts +4 -0
  58. package/dist-types/commands/QueryCommand.d.ts +200 -0
  59. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +6 -0
  60. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +4 -0
  61. package/dist-types/commands/SubmitFeedbackCommand.d.ts +4 -0
  62. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  63. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  64. package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +4 -0
  65. package/dist-types/commands/UpdateDataSourceCommand.d.ts +4 -0
  66. package/dist-types/commands/UpdateExperienceCommand.d.ts +4 -0
  67. package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +21 -0
  68. package/dist-types/commands/UpdateIndexCommand.d.ts +4 -0
  69. package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +4 -0
  70. package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +14 -1
  71. package/dist-types/commands/UpdateThesaurusCommand.d.ts +4 -0
  72. package/dist-types/models/models_0.d.ts +173 -210
  73. package/dist-types/models/models_1.d.ts +213 -2
  74. package/dist-types/ts3.4/commands/GetQuerySuggestionsCommand.d.ts +2 -4
  75. package/dist-types/ts3.4/models/models_0.d.ts +40 -46
  76. package/dist-types/ts3.4/models/models_1.d.ts +53 -3
  77. package/package.json +16 -16
@@ -32,6 +32,24 @@ export interface DescribeFaqCommandOutput extends DescribeFaqResponse, __Metadat
32
32
  * };
33
33
  * const command = new DescribeFaqCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeFaqResponse
36
+ * // Id: "STRING_VALUE",
37
+ * // IndexId: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // Description: "STRING_VALUE",
40
+ * // CreatedAt: new Date("TIMESTAMP"),
41
+ * // UpdatedAt: new Date("TIMESTAMP"),
42
+ * // S3Path: { // S3Path
43
+ * // Bucket: "STRING_VALUE", // required
44
+ * // Key: "STRING_VALUE", // required
45
+ * // },
46
+ * // Status: "CREATING" || "UPDATING" || "ACTIVE" || "DELETING" || "FAILED",
47
+ * // RoleArn: "STRING_VALUE",
48
+ * // ErrorMessage: "STRING_VALUE",
49
+ * // FileFormat: "CSV" || "CSV_WITH_HEADER" || "JSON",
50
+ * // LanguageCode: "STRING_VALUE",
51
+ * // };
52
+ *
35
53
  * ```
36
54
  *
37
55
  * @param DescribeFaqCommandInput - {@link DescribeFaqCommandInput}
@@ -60,6 +78,8 @@ export interface DescribeFaqCommandOutput extends DescribeFaqResponse, __Metadat
60
78
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
61
79
  * Please provide the correct input and try again.</p>
62
80
  *
81
+ * @throws {@link KendraServiceException}
82
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
63
83
  *
64
84
  */
65
85
  export declare class DescribeFaqCommand extends $Command<DescribeFaqCommandInput, DescribeFaqCommandOutput, KendraClientResolvedConfig> {
@@ -34,6 +34,30 @@ export interface DescribeFeaturedResultsSetCommandOutput extends DescribeFeature
34
34
  * };
35
35
  * const command = new DescribeFeaturedResultsSetCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribeFeaturedResultsSetResponse
38
+ * // FeaturedResultsSetId: "STRING_VALUE",
39
+ * // FeaturedResultsSetName: "STRING_VALUE",
40
+ * // Description: "STRING_VALUE",
41
+ * // Status: "ACTIVE" || "INACTIVE",
42
+ * // QueryTexts: [ // QueryTextList
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // FeaturedDocumentsWithMetadata: [ // FeaturedDocumentWithMetadataList
46
+ * // { // FeaturedDocumentWithMetadata
47
+ * // Id: "STRING_VALUE",
48
+ * // Title: "STRING_VALUE",
49
+ * // URI: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // FeaturedDocumentsMissing: [ // FeaturedDocumentMissingList
53
+ * // { // FeaturedDocumentMissing
54
+ * // Id: "STRING_VALUE",
55
+ * // },
56
+ * // ],
57
+ * // LastUpdatedTimestamp: Number("long"),
58
+ * // CreationTimestamp: Number("long"),
59
+ * // };
60
+ *
37
61
  * ```
38
62
  *
39
63
  * @param DescribeFeaturedResultsSetCommandInput - {@link DescribeFeaturedResultsSetCommandInput}
@@ -62,6 +86,8 @@ export interface DescribeFeaturedResultsSetCommandOutput extends DescribeFeature
62
86
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
63
87
  * Please provide the correct input and try again.</p>
64
88
  *
89
+ * @throws {@link KendraServiceException}
90
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
65
91
  *
66
92
  */
67
93
  export declare class DescribeFeaturedResultsSetCommand extends $Command<DescribeFeaturedResultsSetCommandInput, DescribeFeaturedResultsSetCommandOutput, KendraClientResolvedConfig> {
@@ -31,6 +31,76 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met
31
31
  * };
32
32
  * const command = new DescribeIndexCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeIndexResponse
35
+ * // Name: "STRING_VALUE",
36
+ * // Id: "STRING_VALUE",
37
+ * // Edition: "DEVELOPER_EDITION" || "ENTERPRISE_EDITION",
38
+ * // RoleArn: "STRING_VALUE",
39
+ * // ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
40
+ * // KmsKeyId: "STRING_VALUE",
41
+ * // },
42
+ * // Status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING" || "SYSTEM_UPDATING",
43
+ * // Description: "STRING_VALUE",
44
+ * // CreatedAt: new Date("TIMESTAMP"),
45
+ * // UpdatedAt: new Date("TIMESTAMP"),
46
+ * // DocumentMetadataConfigurations: [ // DocumentMetadataConfigurationList
47
+ * // { // DocumentMetadataConfiguration
48
+ * // Name: "STRING_VALUE", // required
49
+ * // Type: "STRING_VALUE" || "STRING_LIST_VALUE" || "LONG_VALUE" || "DATE_VALUE", // required
50
+ * // Relevance: { // Relevance
51
+ * // Freshness: true || false,
52
+ * // Importance: Number("int"),
53
+ * // Duration: "STRING_VALUE",
54
+ * // RankOrder: "ASCENDING" || "DESCENDING",
55
+ * // ValueImportanceMap: { // ValueImportanceMap
56
+ * // "<keys>": Number("int"),
57
+ * // },
58
+ * // },
59
+ * // Search: { // Search
60
+ * // Facetable: true || false,
61
+ * // Searchable: true || false,
62
+ * // Displayable: true || false,
63
+ * // Sortable: true || false,
64
+ * // },
65
+ * // },
66
+ * // ],
67
+ * // IndexStatistics: { // IndexStatistics
68
+ * // FaqStatistics: { // FaqStatistics
69
+ * // IndexedQuestionAnswersCount: Number("int"), // required
70
+ * // },
71
+ * // TextDocumentStatistics: { // TextDocumentStatistics
72
+ * // IndexedTextDocumentsCount: Number("int"), // required
73
+ * // IndexedTextBytes: Number("long"), // required
74
+ * // },
75
+ * // },
76
+ * // ErrorMessage: "STRING_VALUE",
77
+ * // CapacityUnits: { // CapacityUnitsConfiguration
78
+ * // StorageCapacityUnits: Number("int"), // required
79
+ * // QueryCapacityUnits: Number("int"), // required
80
+ * // },
81
+ * // UserTokenConfigurations: [ // UserTokenConfigurationList
82
+ * // { // UserTokenConfiguration
83
+ * // JwtTokenTypeConfiguration: { // JwtTokenTypeConfiguration
84
+ * // KeyLocation: "URL" || "SECRET_MANAGER", // required
85
+ * // URL: "STRING_VALUE",
86
+ * // SecretManagerArn: "STRING_VALUE",
87
+ * // UserNameAttributeField: "STRING_VALUE",
88
+ * // GroupAttributeField: "STRING_VALUE",
89
+ * // Issuer: "STRING_VALUE",
90
+ * // ClaimRegex: "STRING_VALUE",
91
+ * // },
92
+ * // JsonTokenTypeConfiguration: { // JsonTokenTypeConfiguration
93
+ * // UserNameAttributeField: "STRING_VALUE", // required
94
+ * // GroupAttributeField: "STRING_VALUE", // required
95
+ * // },
96
+ * // },
97
+ * // ],
98
+ * // UserContextPolicy: "ATTRIBUTE_FILTER" || "USER_TOKEN",
99
+ * // UserGroupResolutionConfiguration: { // UserGroupResolutionConfiguration
100
+ * // UserGroupResolutionMode: "AWS_SSO" || "NONE", // required
101
+ * // },
102
+ * // };
103
+ *
34
104
  * ```
35
105
  *
36
106
  * @param DescribeIndexCommandInput - {@link DescribeIndexCommandInput}
@@ -59,6 +129,8 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met
59
129
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
60
130
  * Please provide the correct input and try again.</p>
61
131
  *
132
+ * @throws {@link KendraServiceException}
133
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
62
134
  *
63
135
  */
64
136
  export declare class DescribeIndexCommand extends $Command<DescribeIndexCommandInput, DescribeIndexCommandOutput, KendraClientResolvedConfig> {
@@ -40,6 +40,21 @@ export interface DescribePrincipalMappingCommandOutput extends DescribePrincipal
40
40
  * };
41
41
  * const command = new DescribePrincipalMappingCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // DescribePrincipalMappingResponse
44
+ * // IndexId: "STRING_VALUE",
45
+ * // DataSourceId: "STRING_VALUE",
46
+ * // GroupId: "STRING_VALUE",
47
+ * // GroupOrderingIdSummaries: [ // GroupOrderingIdSummaries
48
+ * // { // GroupOrderingIdSummary
49
+ * // Status: "FAILED" || "SUCCEEDED" || "PROCESSING" || "DELETING" || "DELETED",
50
+ * // LastUpdatedAt: new Date("TIMESTAMP"),
51
+ * // ReceivedAt: new Date("TIMESTAMP"),
52
+ * // OrderingId: Number("long"),
53
+ * // FailureReason: "STRING_VALUE",
54
+ * // },
55
+ * // ],
56
+ * // };
57
+ *
43
58
  * ```
44
59
  *
45
60
  * @param DescribePrincipalMappingCommandInput - {@link DescribePrincipalMappingCommandInput}
@@ -68,6 +83,8 @@ export interface DescribePrincipalMappingCommandOutput extends DescribePrincipal
68
83
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
69
84
  * Please provide the correct input and try again.</p>
70
85
  *
86
+ * @throws {@link KendraServiceException}
87
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
71
88
  *
72
89
  */
73
90
  export declare class DescribePrincipalMappingCommand extends $Command<DescribePrincipalMappingCommandInput, DescribePrincipalMappingCommandOutput, KendraClientResolvedConfig> {
@@ -38,6 +38,24 @@ export interface DescribeQuerySuggestionsBlockListCommandOutput extends Describe
38
38
  * };
39
39
  * const command = new DescribeQuerySuggestionsBlockListCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // DescribeQuerySuggestionsBlockListResponse
42
+ * // IndexId: "STRING_VALUE",
43
+ * // Id: "STRING_VALUE",
44
+ * // Name: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // Status: "ACTIVE" || "CREATING" || "DELETING" || "UPDATING" || "ACTIVE_BUT_UPDATE_FAILED" || "FAILED",
47
+ * // ErrorMessage: "STRING_VALUE",
48
+ * // CreatedAt: new Date("TIMESTAMP"),
49
+ * // UpdatedAt: new Date("TIMESTAMP"),
50
+ * // SourceS3Path: { // S3Path
51
+ * // Bucket: "STRING_VALUE", // required
52
+ * // Key: "STRING_VALUE", // required
53
+ * // },
54
+ * // ItemCount: Number("int"),
55
+ * // FileSizeBytes: Number("long"),
56
+ * // RoleArn: "STRING_VALUE",
57
+ * // };
58
+ *
41
59
  * ```
42
60
  *
43
61
  * @param DescribeQuerySuggestionsBlockListCommandInput - {@link DescribeQuerySuggestionsBlockListCommandInput}
@@ -66,6 +84,8 @@ export interface DescribeQuerySuggestionsBlockListCommandOutput extends Describe
66
84
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
67
85
  * Please provide the correct input and try again.</p>
68
86
  *
87
+ * @throws {@link KendraServiceException}
88
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
69
89
  *
70
90
  */
71
91
  export declare class DescribeQuerySuggestionsBlockListCommand extends $Command<DescribeQuerySuggestionsBlockListCommandInput, DescribeQuerySuggestionsBlockListCommandOutput, KendraClientResolvedConfig> {
@@ -36,6 +36,18 @@ export interface DescribeQuerySuggestionsConfigCommandOutput extends DescribeQue
36
36
  * };
37
37
  * const command = new DescribeQuerySuggestionsConfigCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeQuerySuggestionsConfigResponse
40
+ * // Mode: "ENABLED" || "LEARN_ONLY",
41
+ * // Status: "ACTIVE" || "UPDATING",
42
+ * // QueryLogLookBackWindowInDays: Number("int"),
43
+ * // IncludeQueriesWithoutUserInformation: true || false,
44
+ * // MinimumNumberOfQueryingUsers: Number("int"),
45
+ * // MinimumQueryCount: Number("int"),
46
+ * // LastSuggestionsBuildTime: new Date("TIMESTAMP"),
47
+ * // LastClearTime: new Date("TIMESTAMP"),
48
+ * // TotalSuggestionsCount: Number("int"),
49
+ * // };
50
+ *
39
51
  * ```
40
52
  *
41
53
  * @param DescribeQuerySuggestionsConfigCommandInput - {@link DescribeQuerySuggestionsConfigCommandInput}
@@ -64,6 +76,8 @@ export interface DescribeQuerySuggestionsConfigCommandOutput extends DescribeQue
64
76
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
65
77
  * Please provide the correct input and try again.</p>
66
78
  *
79
+ * @throws {@link KendraServiceException}
80
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
67
81
  *
68
82
  */
69
83
  export declare class DescribeQuerySuggestionsConfigCommand extends $Command<DescribeQuerySuggestionsConfigCommandInput, DescribeQuerySuggestionsConfigCommandOutput, KendraClientResolvedConfig> {
@@ -32,6 +32,25 @@ export interface DescribeThesaurusCommandOutput extends DescribeThesaurusRespons
32
32
  * };
33
33
  * const command = new DescribeThesaurusCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeThesaurusResponse
36
+ * // Id: "STRING_VALUE",
37
+ * // IndexId: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // Description: "STRING_VALUE",
40
+ * // Status: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING" || "ACTIVE_BUT_UPDATE_FAILED" || "FAILED",
41
+ * // ErrorMessage: "STRING_VALUE",
42
+ * // CreatedAt: new Date("TIMESTAMP"),
43
+ * // UpdatedAt: new Date("TIMESTAMP"),
44
+ * // RoleArn: "STRING_VALUE",
45
+ * // SourceS3Path: { // S3Path
46
+ * // Bucket: "STRING_VALUE", // required
47
+ * // Key: "STRING_VALUE", // required
48
+ * // },
49
+ * // FileSizeBytes: Number("long"),
50
+ * // TermCount: Number("long"),
51
+ * // SynonymRuleCount: Number("long"),
52
+ * // };
53
+ *
35
54
  * ```
36
55
  *
37
56
  * @param DescribeThesaurusCommandInput - {@link DescribeThesaurusCommandInput}
@@ -60,6 +79,8 @@ export interface DescribeThesaurusCommandOutput extends DescribeThesaurusRespons
60
79
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
61
80
  * Please provide the correct input and try again.</p>
62
81
  *
82
+ * @throws {@link KendraServiceException}
83
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
63
84
  *
64
85
  */
65
86
  export declare class DescribeThesaurusCommand extends $Command<DescribeThesaurusCommandInput, DescribeThesaurusCommandOutput, KendraClientResolvedConfig> {
@@ -42,6 +42,15 @@ export interface DisassociateEntitiesFromExperienceCommandOutput extends Disasso
42
42
  * };
43
43
  * const command = new DisassociateEntitiesFromExperienceCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // DisassociateEntitiesFromExperienceResponse
46
+ * // FailedEntityList: [ // FailedEntityList
47
+ * // { // FailedEntity
48
+ * // EntityId: "STRING_VALUE",
49
+ * // ErrorMessage: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // };
53
+ *
45
54
  * ```
46
55
  *
47
56
  * @param DisassociateEntitiesFromExperienceCommandInput - {@link DisassociateEntitiesFromExperienceCommandInput}
@@ -70,6 +79,8 @@ export interface DisassociateEntitiesFromExperienceCommandOutput extends Disasso
70
79
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
71
80
  * Please provide the correct input and try again.</p>
72
81
  *
82
+ * @throws {@link KendraServiceException}
83
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
73
84
  *
74
85
  */
75
86
  export declare class DisassociateEntitiesFromExperienceCommand extends $Command<DisassociateEntitiesFromExperienceCommandInput, DisassociateEntitiesFromExperienceCommandOutput, KendraClientResolvedConfig> {
@@ -39,6 +39,15 @@ export interface DisassociatePersonasFromEntitiesCommandOutput extends Disassoci
39
39
  * };
40
40
  * const command = new DisassociatePersonasFromEntitiesCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // DisassociatePersonasFromEntitiesResponse
43
+ * // FailedEntityList: [ // FailedEntityList
44
+ * // { // FailedEntity
45
+ * // EntityId: "STRING_VALUE",
46
+ * // ErrorMessage: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // };
50
+ *
42
51
  * ```
43
52
  *
44
53
  * @param DisassociatePersonasFromEntitiesCommandInput - {@link DisassociatePersonasFromEntitiesCommandInput}
@@ -67,6 +76,8 @@ export interface DisassociatePersonasFromEntitiesCommandOutput extends Disassoci
67
76
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
68
77
  * Please provide the correct input and try again.</p>
69
78
  *
79
+ * @throws {@link KendraServiceException}
80
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
70
81
  *
71
82
  */
72
83
  export declare class DisassociatePersonasFromEntitiesCommand extends $Command<DisassociatePersonasFromEntitiesCommandInput, DisassociatePersonasFromEntitiesCommandOutput, KendraClientResolvedConfig> {
@@ -2,7 +2,8 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
5
- import { GetQuerySuggestionsRequest, GetQuerySuggestionsResponse } from "../models/models_0";
5
+ import { GetQuerySuggestionsResponse } from "../models/models_0";
6
+ import { GetQuerySuggestionsRequest } from "../models/models_1";
6
7
  /**
7
8
  * @public
8
9
  *
@@ -33,9 +34,134 @@ export interface GetQuerySuggestionsCommandOutput extends GetQuerySuggestionsRes
33
34
  * IndexId: "STRING_VALUE", // required
34
35
  * QueryText: "STRING_VALUE", // required
35
36
  * MaxSuggestionsCount: Number("int"),
37
+ * SuggestionTypes: [ // SuggestionTypes
38
+ * "QUERY" || "DOCUMENT_ATTRIBUTES",
39
+ * ],
40
+ * AttributeSuggestionsConfig: { // AttributeSuggestionsGetConfig
41
+ * SuggestionAttributes: [ // DocumentAttributeKeyList
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * AdditionalResponseAttributes: [
45
+ * "STRING_VALUE",
46
+ * ],
47
+ * AttributeFilter: { // AttributeFilter
48
+ * AndAllFilters: [ // AttributeFilterList
49
+ * {
50
+ * AndAllFilters: [
51
+ * "<AttributeFilter>",
52
+ * ],
53
+ * OrAllFilters: [
54
+ * "<AttributeFilter>",
55
+ * ],
56
+ * NotFilter: "<AttributeFilter>",
57
+ * EqualsTo: { // DocumentAttribute
58
+ * Key: "STRING_VALUE", // required
59
+ * Value: { // DocumentAttributeValue
60
+ * StringValue: "STRING_VALUE",
61
+ * StringListValue: [ // DocumentAttributeStringListValue
62
+ * "STRING_VALUE",
63
+ * ],
64
+ * LongValue: Number("long"),
65
+ * DateValue: new Date("TIMESTAMP"),
66
+ * },
67
+ * },
68
+ * ContainsAll: {
69
+ * Key: "STRING_VALUE", // required
70
+ * Value: {
71
+ * StringValue: "STRING_VALUE",
72
+ * StringListValue: [
73
+ * "STRING_VALUE",
74
+ * ],
75
+ * LongValue: Number("long"),
76
+ * DateValue: new Date("TIMESTAMP"),
77
+ * },
78
+ * },
79
+ * ContainsAny: {
80
+ * Key: "STRING_VALUE", // required
81
+ * Value: {
82
+ * StringValue: "STRING_VALUE",
83
+ * StringListValue: [
84
+ * "STRING_VALUE",
85
+ * ],
86
+ * LongValue: Number("long"),
87
+ * DateValue: new Date("TIMESTAMP"),
88
+ * },
89
+ * },
90
+ * GreaterThan: {
91
+ * Key: "STRING_VALUE", // required
92
+ * Value: {
93
+ * StringValue: "STRING_VALUE",
94
+ * StringListValue: [
95
+ * "STRING_VALUE",
96
+ * ],
97
+ * LongValue: Number("long"),
98
+ * DateValue: new Date("TIMESTAMP"),
99
+ * },
100
+ * },
101
+ * GreaterThanOrEquals: {
102
+ * Key: "STRING_VALUE", // required
103
+ * Value: {
104
+ * StringValue: "STRING_VALUE",
105
+ * StringListValue: [
106
+ * "STRING_VALUE",
107
+ * ],
108
+ * LongValue: Number("long"),
109
+ * DateValue: new Date("TIMESTAMP"),
110
+ * },
111
+ * },
112
+ * LessThan: "<DocumentAttribute>",
113
+ * LessThanOrEquals: "<DocumentAttribute>",
114
+ * },
115
+ * ],
116
+ * OrAllFilters: [
117
+ * "<AttributeFilter>",
118
+ * ],
119
+ * NotFilter: "<AttributeFilter>",
120
+ * EqualsTo: "<DocumentAttribute>",
121
+ * ContainsAll: "<DocumentAttribute>",
122
+ * ContainsAny: "<DocumentAttribute>",
123
+ * GreaterThan: "<DocumentAttribute>",
124
+ * GreaterThanOrEquals: "<DocumentAttribute>",
125
+ * LessThan: "<DocumentAttribute>",
126
+ * LessThanOrEquals: "<DocumentAttribute>",
127
+ * },
128
+ * UserContext: { // UserContext
129
+ * Token: "STRING_VALUE",
130
+ * UserId: "STRING_VALUE",
131
+ * Groups: [ // Groups
132
+ * "STRING_VALUE",
133
+ * ],
134
+ * DataSourceGroups: [ // DataSourceGroups
135
+ * { // DataSourceGroup
136
+ * GroupId: "STRING_VALUE", // required
137
+ * DataSourceId: "STRING_VALUE", // required
138
+ * },
139
+ * ],
140
+ * },
141
+ * },
36
142
  * };
37
143
  * const command = new GetQuerySuggestionsCommand(input);
38
144
  * const response = await client.send(command);
145
+ * // { // GetQuerySuggestionsResponse
146
+ * // QuerySuggestionsId: "STRING_VALUE",
147
+ * // Suggestions: [ // SuggestionList
148
+ * // { // Suggestion
149
+ * // Id: "STRING_VALUE",
150
+ * // Value: { // SuggestionValue
151
+ * // Text: { // SuggestionTextWithHighlights
152
+ * // Text: "STRING_VALUE",
153
+ * // Highlights: [ // SuggestionHighlightList
154
+ * // { // SuggestionHighlight
155
+ * // BeginOffset: Number("int"),
156
+ * // EndOffset: Number("int"),
157
+ * // },
158
+ * // ],
159
+ * // },
160
+ * // },
161
+ * // },
162
+ * // ],
163
+ * // };
164
+ *
39
165
  * ```
40
166
  *
41
167
  * @param GetQuerySuggestionsCommandInput - {@link GetQuerySuggestionsCommandInput}
@@ -74,6 +200,8 @@ export interface GetQuerySuggestionsCommandOutput extends GetQuerySuggestionsRes
74
200
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
75
201
  * Please provide the correct input and try again.</p>
76
202
  *
203
+ * @throws {@link KendraServiceException}
204
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
77
205
  *
78
206
  */
79
207
  export declare class GetQuerySuggestionsCommand extends $Command<GetQuerySuggestionsCommandInput, GetQuerySuggestionsCommandOutput, KendraClientResolvedConfig> {
@@ -36,6 +36,22 @@ export interface GetSnapshotsCommandOutput extends GetSnapshotsResponse, __Metad
36
36
  * };
37
37
  * const command = new GetSnapshotsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // GetSnapshotsResponse
40
+ * // SnapShotTimeFilter: { // TimeRange
41
+ * // StartTime: new Date("TIMESTAMP"),
42
+ * // EndTime: new Date("TIMESTAMP"),
43
+ * // },
44
+ * // SnapshotsDataHeader: [ // SnapshotsDataHeaderFields
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // SnapshotsData: [ // SnapshotsDataRecords
48
+ * // [ // SnapshotsDataRecord
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // ],
52
+ * // NextToken: "STRING_VALUE",
53
+ * // };
54
+ *
39
55
  * ```
40
56
  *
41
57
  * @param GetSnapshotsCommandInput - {@link GetSnapshotsCommandInput}
@@ -60,6 +76,8 @@ export interface GetSnapshotsCommandOutput extends GetSnapshotsResponse, __Metad
60
76
  * <p>The resource you want to use doesn’t exist. Please check you have provided the correct
61
77
  * resource and try again.</p>
62
78
  *
79
+ * @throws {@link KendraServiceException}
80
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
63
81
  *
64
82
  */
65
83
  export declare class GetSnapshotsCommand extends $Command<GetSnapshotsCommandInput, GetSnapshotsCommandOutput, KendraClientResolvedConfig> {
@@ -36,6 +36,15 @@ export interface ListAccessControlConfigurationsCommandOutput extends ListAccess
36
36
  * };
37
37
  * const command = new ListAccessControlConfigurationsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListAccessControlConfigurationsResponse
40
+ * // NextToken: "STRING_VALUE",
41
+ * // AccessControlConfigurations: [ // AccessControlConfigurationSummaryList // required
42
+ * // { // AccessControlConfigurationSummary
43
+ * // Id: "STRING_VALUE", // required
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
39
48
  * ```
40
49
  *
41
50
  * @param ListAccessControlConfigurationsCommandInput - {@link ListAccessControlConfigurationsCommandInput}
@@ -64,6 +73,8 @@ export interface ListAccessControlConfigurationsCommandOutput extends ListAccess
64
73
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
65
74
  * Please provide the correct input and try again.</p>
66
75
  *
76
+ * @throws {@link KendraServiceException}
77
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
67
78
  *
68
79
  */
69
80
  export declare class ListAccessControlConfigurationsCommand extends $Command<ListAccessControlConfigurationsCommandInput, ListAccessControlConfigurationsCommandOutput, KendraClientResolvedConfig> {
@@ -39,6 +39,28 @@ export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJ
39
39
  * };
40
40
  * const command = new ListDataSourceSyncJobsCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListDataSourceSyncJobsResponse
43
+ * // History: [ // DataSourceSyncJobHistoryList
44
+ * // { // DataSourceSyncJob
45
+ * // ExecutionId: "STRING_VALUE",
46
+ * // StartTime: new Date("TIMESTAMP"),
47
+ * // EndTime: new Date("TIMESTAMP"),
48
+ * // Status: "FAILED" || "SUCCEEDED" || "SYNCING" || "INCOMPLETE" || "STOPPING" || "ABORTED" || "SYNCING_INDEXING",
49
+ * // ErrorMessage: "STRING_VALUE",
50
+ * // ErrorCode: "InternalError" || "InvalidRequest",
51
+ * // DataSourceErrorCode: "STRING_VALUE",
52
+ * // Metrics: { // DataSourceSyncJobMetrics
53
+ * // DocumentsAdded: "STRING_VALUE",
54
+ * // DocumentsModified: "STRING_VALUE",
55
+ * // DocumentsDeleted: "STRING_VALUE",
56
+ * // DocumentsFailed: "STRING_VALUE",
57
+ * // DocumentsScanned: "STRING_VALUE",
58
+ * // },
59
+ * // },
60
+ * // ],
61
+ * // NextToken: "STRING_VALUE",
62
+ * // };
63
+ *
42
64
  * ```
43
65
  *
44
66
  * @param ListDataSourceSyncJobsCommandInput - {@link ListDataSourceSyncJobsCommandInput}
@@ -71,6 +93,8 @@ export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJ
71
93
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
72
94
  * Please provide the correct input and try again.</p>
73
95
  *
96
+ * @throws {@link KendraServiceException}
97
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
74
98
  *
75
99
  */
76
100
  export declare class ListDataSourceSyncJobsCommand extends $Command<ListDataSourceSyncJobsCommandInput, ListDataSourceSyncJobsCommandOutput, KendraClientResolvedConfig> {
@@ -33,6 +33,21 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
33
33
  * };
34
34
  * const command = new ListDataSourcesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListDataSourcesResponse
37
+ * // SummaryItems: [ // DataSourceSummaryList
38
+ * // { // DataSourceSummary
39
+ * // Name: "STRING_VALUE",
40
+ * // Id: "STRING_VALUE",
41
+ * // Type: "S3" || "SHAREPOINT" || "DATABASE" || "SALESFORCE" || "ONEDRIVE" || "SERVICENOW" || "CUSTOM" || "CONFLUENCE" || "GOOGLEDRIVE" || "WEBCRAWLER" || "WORKDOCS" || "FSX" || "SLACK" || "BOX" || "QUIP" || "JIRA" || "GITHUB" || "ALFRESCO" || "TEMPLATE",
42
+ * // CreatedAt: new Date("TIMESTAMP"),
43
+ * // UpdatedAt: new Date("TIMESTAMP"),
44
+ * // Status: "CREATING" || "DELETING" || "FAILED" || "UPDATING" || "ACTIVE",
45
+ * // LanguageCode: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // NextToken: "STRING_VALUE",
49
+ * // };
50
+ *
36
51
  * ```
37
52
  *
38
53
  * @param ListDataSourcesCommandInput - {@link ListDataSourcesCommandInput}
@@ -61,6 +76,8 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
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 ListDataSourcesCommand extends $Command<ListDataSourcesCommandInput, ListDataSourcesCommandOutput, KendraClientResolvedConfig> {
@@ -35,6 +35,18 @@ export interface ListEntityPersonasCommandOutput extends ListEntityPersonasRespo
35
35
  * };
36
36
  * const command = new ListEntityPersonasCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListEntityPersonasResponse
39
+ * // SummaryItems: [ // PersonasSummaryList
40
+ * // { // PersonasSummary
41
+ * // EntityId: "STRING_VALUE",
42
+ * // Persona: "OWNER" || "VIEWER",
43
+ * // CreatedAt: new Date("TIMESTAMP"),
44
+ * // UpdatedAt: new Date("TIMESTAMP"),
45
+ * // },
46
+ * // ],
47
+ * // NextToken: "STRING_VALUE",
48
+ * // };
49
+ *
38
50
  * ```
39
51
  *
40
52
  * @param ListEntityPersonasCommandInput - {@link ListEntityPersonasCommandInput}
@@ -63,6 +75,8 @@ export interface ListEntityPersonasCommandOutput extends ListEntityPersonasRespo
63
75
  * <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
64
76
  * Please provide the correct input and try again.</p>
65
77
  *
78
+ * @throws {@link KendraServiceException}
79
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
66
80
  *
67
81
  */
68
82
  export declare class ListEntityPersonasCommand extends $Command<ListEntityPersonasCommandInput, ListEntityPersonasCommandOutput, KendraClientResolvedConfig> {