aws-sdk 2.1345.0 → 2.1347.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/CHANGELOG.md +23 -1
- package/README.md +1 -1
- package/apis/autoscaling-2011-01-01.examples.json +72 -0
- package/apis/autoscaling-2011-01-01.min.json +13 -5
- package/apis/autoscaling-2011-01-01.paginators.json +5 -0
- package/apis/batch-2016-08-10.min.json +4 -1
- package/apis/compute-optimizer-2019-11-01.min.json +15 -11
- package/apis/drs-2020-02-26.min.json +21 -2
- package/apis/ec2-2016-11-15.min.json +754 -660
- package/apis/elasticmapreduce-2009-03-31.min.json +82 -66
- package/apis/glue-2017-03-31.min.json +0 -1
- package/apis/guardduty-2017-11-28.min.json +590 -111
- package/apis/guardduty-2017-11-28.paginators.json +6 -0
- package/apis/imagebuilder-2019-12-02.min.json +546 -75
- package/apis/imagebuilder-2019-12-02.paginators.json +23 -0
- package/apis/ivs-2020-07-14.min.json +58 -46
- package/apis/kendra-2019-02-03.min.json +494 -240
- package/apis/metadata.json +4 -0
- package/apis/network-firewall-2020-11-12.min.json +238 -9
- package/apis/network-firewall-2020-11-12.paginators.json +6 -0
- package/apis/rds-2014-10-31.min.json +4 -3
- package/apis/sagemaker-geospatial-2020-05-27.min.json +135 -107
- package/apis/vpc-lattice-2022-11-30.examples.json +5 -0
- package/apis/vpc-lattice-2022-11-30.min.json +2363 -0
- package/apis/vpc-lattice-2022-11-30.paginators.json +58 -0
- package/apis/wellarchitected-2020-03-31.min.json +125 -21
- package/apis/wellarchitected-2020-03-31.paginators.json +5 -0
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/autoscaling.d.ts +63 -36
- package/clients/batch.d.ts +13 -0
- package/clients/computeoptimizer.d.ts +13 -3
- package/clients/drs.d.ts +25 -5
- package/clients/ec2.d.ts +112 -1
- package/clients/emr.d.ts +20 -0
- package/clients/glue.d.ts +0 -4
- package/clients/guardduty.d.ts +491 -8
- package/clients/imagebuilder.d.ts +931 -128
- package/clients/ivs.d.ts +17 -0
- package/clients/kendra.d.ts +424 -75
- package/clients/networkfirewall.d.ts +289 -0
- package/clients/opensearchserverless.d.ts +6 -6
- package/clients/rds.d.ts +25 -17
- package/clients/sagemakergeospatial.d.ts +183 -147
- package/clients/vpclattice.d.ts +2772 -0
- package/clients/vpclattice.js +18 -0
- package/clients/wellarchitected.d.ts +125 -34
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +61 -24
- package/dist/aws-sdk.js +865 -737
- package/dist/aws-sdk.min.js +97 -96
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/kendra.d.ts
CHANGED
|
@@ -35,6 +35,14 @@ declare class Kendra extends Service {
|
|
|
35
35
|
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
|
|
36
36
|
*/
|
|
37
37
|
batchDeleteDocument(callback?: (err: AWSError, data: Kendra.Types.BatchDeleteDocumentResponse) => void): Request<Kendra.Types.BatchDeleteDocumentResponse, AWSError>;
|
|
38
|
+
/**
|
|
39
|
+
* Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
|
|
40
|
+
*/
|
|
41
|
+
batchDeleteFeaturedResultsSet(params: Kendra.Types.BatchDeleteFeaturedResultsSetRequest, callback?: (err: AWSError, data: Kendra.Types.BatchDeleteFeaturedResultsSetResponse) => void): Request<Kendra.Types.BatchDeleteFeaturedResultsSetResponse, AWSError>;
|
|
42
|
+
/**
|
|
43
|
+
* Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
|
|
44
|
+
*/
|
|
45
|
+
batchDeleteFeaturedResultsSet(callback?: (err: AWSError, data: Kendra.Types.BatchDeleteFeaturedResultsSetResponse) => void): Request<Kendra.Types.BatchDeleteFeaturedResultsSetResponse, AWSError>;
|
|
38
46
|
/**
|
|
39
47
|
* Returns the indexing status for one or more documents submitted with the BatchPutDocument API. When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed. You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
|
|
40
48
|
*/
|
|
@@ -68,11 +76,11 @@ declare class Kendra extends Service {
|
|
|
68
76
|
*/
|
|
69
77
|
createAccessControlConfiguration(callback?: (err: AWSError, data: Kendra.Types.CreateAccessControlConfigurationResponse) => void): Request<Kendra.Types.CreateAccessControlConfigurationResponse, AWSError>;
|
|
70
78
|
/**
|
|
71
|
-
* Creates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
|
|
79
|
+
* Creates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
|
72
80
|
*/
|
|
73
81
|
createDataSource(params: Kendra.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: Kendra.Types.CreateDataSourceResponse) => void): Request<Kendra.Types.CreateDataSourceResponse, AWSError>;
|
|
74
82
|
/**
|
|
75
|
-
* Creates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
|
|
83
|
+
* Creates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
|
76
84
|
*/
|
|
77
85
|
createDataSource(callback?: (err: AWSError, data: Kendra.Types.CreateDataSourceResponse) => void): Request<Kendra.Types.CreateDataSourceResponse, AWSError>;
|
|
78
86
|
/**
|
|
@@ -84,13 +92,21 @@ declare class Kendra extends Service {
|
|
|
84
92
|
*/
|
|
85
93
|
createExperience(callback?: (err: AWSError, data: Kendra.Types.CreateExperienceResponse) => void): Request<Kendra.Types.CreateExperienceResponse, AWSError>;
|
|
86
94
|
/**
|
|
87
|
-
* Creates
|
|
95
|
+
* Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket. Adding FAQs to an index is an asynchronous operation. For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
|
|
88
96
|
*/
|
|
89
97
|
createFaq(params: Kendra.Types.CreateFaqRequest, callback?: (err: AWSError, data: Kendra.Types.CreateFaqResponse) => void): Request<Kendra.Types.CreateFaqResponse, AWSError>;
|
|
90
98
|
/**
|
|
91
|
-
* Creates
|
|
99
|
+
* Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket. Adding FAQs to an index is an asynchronous operation. For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
|
|
92
100
|
*/
|
|
93
101
|
createFaq(callback?: (err: AWSError, data: Kendra.Types.CreateFaqResponse) => void): Request<Kendra.Types.CreateFaqResponse, AWSError>;
|
|
102
|
+
/**
|
|
103
|
+
* Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results. You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
|
|
104
|
+
*/
|
|
105
|
+
createFeaturedResultsSet(params: Kendra.Types.CreateFeaturedResultsSetRequest, callback?: (err: AWSError, data: Kendra.Types.CreateFeaturedResultsSetResponse) => void): Request<Kendra.Types.CreateFeaturedResultsSetResponse, AWSError>;
|
|
106
|
+
/**
|
|
107
|
+
* Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results. You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
|
|
108
|
+
*/
|
|
109
|
+
createFeaturedResultsSet(callback?: (err: AWSError, data: Kendra.Types.CreateFeaturedResultsSetResponse) => void): Request<Kendra.Types.CreateFeaturedResultsSetResponse, AWSError>;
|
|
94
110
|
/**
|
|
95
111
|
* Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
|
96
112
|
*/
|
|
@@ -211,6 +227,14 @@ declare class Kendra extends Service {
|
|
|
211
227
|
* Gets information about an FAQ list.
|
|
212
228
|
*/
|
|
213
229
|
describeFaq(callback?: (err: AWSError, data: Kendra.Types.DescribeFaqResponse) => void): Request<Kendra.Types.DescribeFaqResponse, AWSError>;
|
|
230
|
+
/**
|
|
231
|
+
* Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
|
|
232
|
+
*/
|
|
233
|
+
describeFeaturedResultsSet(params: Kendra.Types.DescribeFeaturedResultsSetRequest, callback?: (err: AWSError, data: Kendra.Types.DescribeFeaturedResultsSetResponse) => void): Request<Kendra.Types.DescribeFeaturedResultsSetResponse, AWSError>;
|
|
234
|
+
/**
|
|
235
|
+
* Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
|
|
236
|
+
*/
|
|
237
|
+
describeFeaturedResultsSet(callback?: (err: AWSError, data: Kendra.Types.DescribeFeaturedResultsSetResponse) => void): Request<Kendra.Types.DescribeFeaturedResultsSetResponse, AWSError>;
|
|
214
238
|
/**
|
|
215
239
|
* Gets information about an existing Amazon Kendra index.
|
|
216
240
|
*/
|
|
@@ -339,6 +363,14 @@ declare class Kendra extends Service {
|
|
|
339
363
|
* Gets a list of FAQ lists associated with an index.
|
|
340
364
|
*/
|
|
341
365
|
listFaqs(callback?: (err: AWSError, data: Kendra.Types.ListFaqsResponse) => void): Request<Kendra.Types.ListFaqsResponse, AWSError>;
|
|
366
|
+
/**
|
|
367
|
+
* Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
|
|
368
|
+
*/
|
|
369
|
+
listFeaturedResultsSets(params: Kendra.Types.ListFeaturedResultsSetsRequest, callback?: (err: AWSError, data: Kendra.Types.ListFeaturedResultsSetsResponse) => void): Request<Kendra.Types.ListFeaturedResultsSetsResponse, AWSError>;
|
|
370
|
+
/**
|
|
371
|
+
* Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
|
|
372
|
+
*/
|
|
373
|
+
listFeaturedResultsSets(callback?: (err: AWSError, data: Kendra.Types.ListFeaturedResultsSetsResponse) => void): Request<Kendra.Types.ListFeaturedResultsSetsResponse, AWSError>;
|
|
342
374
|
/**
|
|
343
375
|
* Provides a list of groups that are mapped to users before a given ordering or timestamp identifier. ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.
|
|
344
376
|
*/
|
|
@@ -380,11 +412,11 @@ declare class Kendra extends Service {
|
|
|
380
412
|
*/
|
|
381
413
|
listThesauri(callback?: (err: AWSError, data: Kendra.Types.ListThesauriResponse) => void): Request<Kendra.Types.ListThesauriResponse, AWSError>;
|
|
382
414
|
/**
|
|
383
|
-
* Maps users to their groups so that you only need to provide the user ID when you issue the query. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context. If more than five PUT actions for a group are currently processing, a validation exception is thrown.
|
|
415
|
+
* Maps users to their groups so that you only need to provide the user ID when you issue the query. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context. If more than five PUT actions for a group are currently processing, a validation exception is thrown.
|
|
384
416
|
*/
|
|
385
417
|
putPrincipalMapping(params: Kendra.Types.PutPrincipalMappingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
386
418
|
/**
|
|
387
|
-
* Maps users to their groups so that you only need to provide the user ID when you issue the query. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context. If more than five PUT actions for a group are currently processing, a validation exception is thrown.
|
|
419
|
+
* Maps users to their groups so that you only need to provide the user ID when you issue the query. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context. If more than five PUT actions for a group are currently processing, a validation exception is thrown.
|
|
388
420
|
*/
|
|
389
421
|
putPrincipalMapping(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
390
422
|
/**
|
|
@@ -459,6 +491,14 @@ declare class Kendra extends Service {
|
|
|
459
491
|
* Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
|
|
460
492
|
*/
|
|
461
493
|
updateExperience(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
494
|
+
/**
|
|
495
|
+
* Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
|
|
496
|
+
*/
|
|
497
|
+
updateFeaturedResultsSet(params: Kendra.Types.UpdateFeaturedResultsSetRequest, callback?: (err: AWSError, data: Kendra.Types.UpdateFeaturedResultsSetResponse) => void): Request<Kendra.Types.UpdateFeaturedResultsSetResponse, AWSError>;
|
|
498
|
+
/**
|
|
499
|
+
* Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
|
|
500
|
+
*/
|
|
501
|
+
updateFeaturedResultsSet(callback?: (err: AWSError, data: Kendra.Types.UpdateFeaturedResultsSetResponse) => void): Request<Kendra.Types.UpdateFeaturedResultsSetResponse, AWSError>;
|
|
462
502
|
/**
|
|
463
503
|
* Updates an existing Amazon Kendra index.
|
|
464
504
|
*/
|
|
@@ -730,6 +770,37 @@ declare namespace Kendra {
|
|
|
730
770
|
ErrorMessage?: ErrorMessage;
|
|
731
771
|
}
|
|
732
772
|
export type BatchDeleteDocumentResponseFailedDocuments = BatchDeleteDocumentResponseFailedDocument[];
|
|
773
|
+
export interface BatchDeleteFeaturedResultsSetError {
|
|
774
|
+
/**
|
|
775
|
+
* The identifier of the set of featured results that couldn't be removed from the index.
|
|
776
|
+
*/
|
|
777
|
+
Id: FeaturedResultsSetId;
|
|
778
|
+
/**
|
|
779
|
+
* The error code for why the set of featured results couldn't be removed from the index.
|
|
780
|
+
*/
|
|
781
|
+
ErrorCode: ErrorCode;
|
|
782
|
+
/**
|
|
783
|
+
* An explanation for why the set of featured results couldn't be removed from the index.
|
|
784
|
+
*/
|
|
785
|
+
ErrorMessage: ErrorMessage;
|
|
786
|
+
}
|
|
787
|
+
export type BatchDeleteFeaturedResultsSetErrors = BatchDeleteFeaturedResultsSetError[];
|
|
788
|
+
export interface BatchDeleteFeaturedResultsSetRequest {
|
|
789
|
+
/**
|
|
790
|
+
* The identifier of the index used for featuring results.
|
|
791
|
+
*/
|
|
792
|
+
IndexId: IndexId;
|
|
793
|
+
/**
|
|
794
|
+
* The identifiers of the featured results sets that you want to delete.
|
|
795
|
+
*/
|
|
796
|
+
FeaturedResultsSetIds: FeaturedResultsSetIdList;
|
|
797
|
+
}
|
|
798
|
+
export interface BatchDeleteFeaturedResultsSetResponse {
|
|
799
|
+
/**
|
|
800
|
+
* The list of errors for the featured results set IDs, explaining why they couldn't be removed from the index.
|
|
801
|
+
*/
|
|
802
|
+
Errors: BatchDeleteFeaturedResultsSetErrors;
|
|
803
|
+
}
|
|
733
804
|
export interface BatchGetDocumentStatusRequest {
|
|
734
805
|
/**
|
|
735
806
|
* The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.
|
|
@@ -771,11 +842,11 @@ declare namespace Kendra {
|
|
|
771
842
|
*/
|
|
772
843
|
IndexId: IndexId;
|
|
773
844
|
/**
|
|
774
|
-
* The Amazon Resource Name (ARN) of
|
|
845
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see IAM access roles for Amazon Kendra.
|
|
775
846
|
*/
|
|
776
847
|
RoleArn?: RoleArn;
|
|
777
848
|
/**
|
|
778
|
-
* One or more documents to add to the index. Documents have the following file size limits.
|
|
849
|
+
* One or more documents to add to the index. Documents have the following file size limits. 50 MB total size for any file 5 MB extracted text for any file For more information, see Quotas.
|
|
779
850
|
*/
|
|
780
851
|
Documents: DocumentList;
|
|
781
852
|
/**
|
|
@@ -884,7 +955,7 @@ declare namespace Kendra {
|
|
|
884
955
|
*/
|
|
885
956
|
ResultId: ResultId;
|
|
886
957
|
/**
|
|
887
|
-
* The Unix timestamp
|
|
958
|
+
* The Unix timestamp when the result was clicked.
|
|
888
959
|
*/
|
|
889
960
|
ClickTime: Timestamp;
|
|
890
961
|
}
|
|
@@ -1191,15 +1262,15 @@ declare namespace Kendra {
|
|
|
1191
1262
|
*/
|
|
1192
1263
|
Description?: Description;
|
|
1193
1264
|
/**
|
|
1194
|
-
* Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
|
|
1265
|
+
* Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index. Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
|
|
1195
1266
|
*/
|
|
1196
1267
|
Schedule?: ScanSchedule;
|
|
1197
1268
|
/**
|
|
1198
|
-
* The Amazon Resource Name (ARN) of
|
|
1269
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra.. You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception. The RoleArn parameter is required for all other data sources.
|
|
1199
1270
|
*/
|
|
1200
1271
|
RoleArn?: RoleArn;
|
|
1201
1272
|
/**
|
|
1202
|
-
* A list of key-value pairs that identify the data source connector. You can use
|
|
1273
|
+
* A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
|
1203
1274
|
*/
|
|
1204
1275
|
Tags?: TagList;
|
|
1205
1276
|
/**
|
|
@@ -1231,7 +1302,7 @@ declare namespace Kendra {
|
|
|
1231
1302
|
*/
|
|
1232
1303
|
IndexId: IndexId;
|
|
1233
1304
|
/**
|
|
1234
|
-
* The Amazon Resource Name (ARN) of
|
|
1305
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access Query API, GetQuerySuggestions API, and other required APIs. The role also must include permission to access IAM Identity Center (successor to Single Sign-On) that stores your user and group information. For more information, see IAM access roles for Amazon Kendra.
|
|
1235
1306
|
*/
|
|
1236
1307
|
RoleArn?: RoleArn;
|
|
1237
1308
|
/**
|
|
@@ -1249,7 +1320,7 @@ declare namespace Kendra {
|
|
|
1249
1320
|
}
|
|
1250
1321
|
export interface CreateExperienceResponse {
|
|
1251
1322
|
/**
|
|
1252
|
-
* The identifier
|
|
1323
|
+
* The identifier of your Amazon Kendra experience.
|
|
1253
1324
|
*/
|
|
1254
1325
|
Id: ExperienceId;
|
|
1255
1326
|
}
|
|
@@ -1271,7 +1342,7 @@ declare namespace Kendra {
|
|
|
1271
1342
|
*/
|
|
1272
1343
|
S3Path: S3Path;
|
|
1273
1344
|
/**
|
|
1274
|
-
* The Amazon Resource Name (ARN) of
|
|
1345
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.
|
|
1275
1346
|
*/
|
|
1276
1347
|
RoleArn: RoleArn;
|
|
1277
1348
|
/**
|
|
@@ -1297,17 +1368,57 @@ declare namespace Kendra {
|
|
|
1297
1368
|
*/
|
|
1298
1369
|
Id?: FaqId;
|
|
1299
1370
|
}
|
|
1371
|
+
export interface CreateFeaturedResultsSetRequest {
|
|
1372
|
+
/**
|
|
1373
|
+
* The identifier of the index that you want to use for featuring results.
|
|
1374
|
+
*/
|
|
1375
|
+
IndexId: IndexId;
|
|
1376
|
+
/**
|
|
1377
|
+
* A name for the set of featured results.
|
|
1378
|
+
*/
|
|
1379
|
+
FeaturedResultsSetName: FeaturedResultsSetName;
|
|
1380
|
+
/**
|
|
1381
|
+
* A description for the set of featured results.
|
|
1382
|
+
*/
|
|
1383
|
+
Description?: FeaturedResultsSetDescription;
|
|
1384
|
+
/**
|
|
1385
|
+
* A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.
|
|
1386
|
+
*/
|
|
1387
|
+
ClientToken?: ClientTokenName;
|
|
1388
|
+
/**
|
|
1389
|
+
* The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
|
|
1390
|
+
*/
|
|
1391
|
+
Status?: FeaturedResultsSetStatus;
|
|
1392
|
+
/**
|
|
1393
|
+
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
|
|
1394
|
+
*/
|
|
1395
|
+
QueryTexts?: QueryTextList;
|
|
1396
|
+
/**
|
|
1397
|
+
* A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.
|
|
1398
|
+
*/
|
|
1399
|
+
FeaturedDocuments?: FeaturedDocumentList;
|
|
1400
|
+
/**
|
|
1401
|
+
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.
|
|
1402
|
+
*/
|
|
1403
|
+
Tags?: TagList;
|
|
1404
|
+
}
|
|
1405
|
+
export interface CreateFeaturedResultsSetResponse {
|
|
1406
|
+
/**
|
|
1407
|
+
* Information on the set of featured results. This includes the identifier of the featured results set, whether the featured results set is active or inactive, when the featured results set was created, and more.
|
|
1408
|
+
*/
|
|
1409
|
+
FeaturedResultsSet?: FeaturedResultsSet;
|
|
1410
|
+
}
|
|
1300
1411
|
export interface CreateIndexRequest {
|
|
1301
1412
|
/**
|
|
1302
1413
|
* A name for the index.
|
|
1303
1414
|
*/
|
|
1304
1415
|
Name: IndexName;
|
|
1305
1416
|
/**
|
|
1306
|
-
* The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for
|
|
1417
|
+
* The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed. The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION. For more information on quota limits for Enterprise and Developer editions, see Quotas.
|
|
1307
1418
|
*/
|
|
1308
1419
|
Edition?: IndexEdition;
|
|
1309
1420
|
/**
|
|
1310
|
-
*
|
|
1421
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.
|
|
1311
1422
|
*/
|
|
1312
1423
|
RoleArn: RoleArn;
|
|
1313
1424
|
/**
|
|
@@ -1323,7 +1434,7 @@ declare namespace Kendra {
|
|
|
1323
1434
|
*/
|
|
1324
1435
|
ClientToken?: ClientTokenName;
|
|
1325
1436
|
/**
|
|
1326
|
-
* A list of key-value pairs that identify the index. You can use
|
|
1437
|
+
* A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
|
1327
1438
|
*/
|
|
1328
1439
|
Tags?: TagList;
|
|
1329
1440
|
/**
|
|
@@ -1335,7 +1446,7 @@ declare namespace Kendra {
|
|
|
1335
1446
|
*/
|
|
1336
1447
|
UserContextPolicy?: UserContextPolicy;
|
|
1337
1448
|
/**
|
|
1338
|
-
*
|
|
1449
|
+
* Gets users and groups from IAM Identity Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.
|
|
1339
1450
|
*/
|
|
1340
1451
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
|
|
1341
1452
|
}
|
|
@@ -1351,11 +1462,11 @@ declare namespace Kendra {
|
|
|
1351
1462
|
*/
|
|
1352
1463
|
IndexId: IndexId;
|
|
1353
1464
|
/**
|
|
1354
|
-
* A
|
|
1465
|
+
* A name for the block list. For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.
|
|
1355
1466
|
*/
|
|
1356
1467
|
Name: QuerySuggestionsBlockListName;
|
|
1357
1468
|
/**
|
|
1358
|
-
* A
|
|
1469
|
+
* A description for the block list. For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."
|
|
1359
1470
|
*/
|
|
1360
1471
|
Description?: Description;
|
|
1361
1472
|
/**
|
|
@@ -1367,17 +1478,17 @@ declare namespace Kendra {
|
|
|
1367
1478
|
*/
|
|
1368
1479
|
ClientToken?: ClientTokenName;
|
|
1369
1480
|
/**
|
|
1370
|
-
* The
|
|
1481
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.
|
|
1371
1482
|
*/
|
|
1372
1483
|
RoleArn: RoleArn;
|
|
1373
1484
|
/**
|
|
1374
|
-
* A
|
|
1485
|
+
* A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
|
1375
1486
|
*/
|
|
1376
1487
|
Tags?: TagList;
|
|
1377
1488
|
}
|
|
1378
1489
|
export interface CreateQuerySuggestionsBlockListResponse {
|
|
1379
1490
|
/**
|
|
1380
|
-
* The identifier of the
|
|
1491
|
+
* The identifier of the block list.
|
|
1381
1492
|
*/
|
|
1382
1493
|
Id?: QuerySuggestionsBlockListId;
|
|
1383
1494
|
}
|
|
@@ -1395,11 +1506,11 @@ declare namespace Kendra {
|
|
|
1395
1506
|
*/
|
|
1396
1507
|
Description?: Description;
|
|
1397
1508
|
/**
|
|
1398
|
-
*
|
|
1509
|
+
* The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see IAM access roles for Amazon Kendra.
|
|
1399
1510
|
*/
|
|
1400
1511
|
RoleArn: RoleArn;
|
|
1401
1512
|
/**
|
|
1402
|
-
* A list of key-value pairs that identify the thesaurus. You can use
|
|
1513
|
+
* A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
|
|
1403
1514
|
*/
|
|
1404
1515
|
Tags?: TagList;
|
|
1405
1516
|
/**
|
|
@@ -1539,11 +1650,11 @@ declare namespace Kendra {
|
|
|
1539
1650
|
*/
|
|
1540
1651
|
Type?: DataSourceType;
|
|
1541
1652
|
/**
|
|
1542
|
-
* The
|
|
1653
|
+
* The Unix timestamp when the data source connector was created.
|
|
1543
1654
|
*/
|
|
1544
1655
|
CreatedAt?: Timestamp;
|
|
1545
1656
|
/**
|
|
1546
|
-
* The
|
|
1657
|
+
* The Unix timestamp when the data source connector was last updated.
|
|
1547
1658
|
*/
|
|
1548
1659
|
UpdatedAt?: Timestamp;
|
|
1549
1660
|
/**
|
|
@@ -1562,11 +1673,11 @@ declare namespace Kendra {
|
|
|
1562
1673
|
*/
|
|
1563
1674
|
ExecutionId?: String;
|
|
1564
1675
|
/**
|
|
1565
|
-
* The
|
|
1676
|
+
* The Unix timestamp when the synchronization job started.
|
|
1566
1677
|
*/
|
|
1567
1678
|
StartTime?: Timestamp;
|
|
1568
1679
|
/**
|
|
1569
|
-
* The
|
|
1680
|
+
* The Unix timestamp when the synchronization job completed.
|
|
1570
1681
|
*/
|
|
1571
1682
|
EndTime?: Timestamp;
|
|
1572
1683
|
/**
|
|
@@ -1742,7 +1853,7 @@ declare namespace Kendra {
|
|
|
1742
1853
|
*/
|
|
1743
1854
|
GroupId: GroupId;
|
|
1744
1855
|
/**
|
|
1745
|
-
* The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action. The ordering ID can be the
|
|
1856
|
+
* The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action. The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your DELETE action for that updated group with the latest members list doesn't get overwritten by earlier DELETE actions for the same group which are yet to be processed. The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.
|
|
1746
1857
|
*/
|
|
1747
1858
|
OrderingId?: PrincipalOrderingId;
|
|
1748
1859
|
}
|
|
@@ -1834,11 +1945,11 @@ declare namespace Kendra {
|
|
|
1834
1945
|
*/
|
|
1835
1946
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1836
1947
|
/**
|
|
1837
|
-
* The Unix timestamp
|
|
1948
|
+
* The Unix timestamp when the data source connector was created.
|
|
1838
1949
|
*/
|
|
1839
1950
|
CreatedAt?: Timestamp;
|
|
1840
1951
|
/**
|
|
1841
|
-
* The Unix timestamp
|
|
1952
|
+
* The Unix timestamp when the data source connector was last updated.
|
|
1842
1953
|
*/
|
|
1843
1954
|
UpdatedAt?: Timestamp;
|
|
1844
1955
|
/**
|
|
@@ -1902,11 +2013,11 @@ declare namespace Kendra {
|
|
|
1902
2013
|
*/
|
|
1903
2014
|
Configuration?: ExperienceConfiguration;
|
|
1904
2015
|
/**
|
|
1905
|
-
*
|
|
2016
|
+
* The Unix timestamp when your Amazon Kendra experience was created.
|
|
1906
2017
|
*/
|
|
1907
2018
|
CreatedAt?: Timestamp;
|
|
1908
2019
|
/**
|
|
1909
|
-
*
|
|
2020
|
+
* The Unix timestamp when your Amazon Kendra experience was last updated.
|
|
1910
2021
|
*/
|
|
1911
2022
|
UpdatedAt?: Timestamp;
|
|
1912
2023
|
/**
|
|
@@ -1954,11 +2065,11 @@ declare namespace Kendra {
|
|
|
1954
2065
|
*/
|
|
1955
2066
|
Description?: Description;
|
|
1956
2067
|
/**
|
|
1957
|
-
* The
|
|
2068
|
+
* The Unix timestamp when the FAQ was created.
|
|
1958
2069
|
*/
|
|
1959
2070
|
CreatedAt?: Timestamp;
|
|
1960
2071
|
/**
|
|
1961
|
-
* The
|
|
2072
|
+
* The Unix timestamp when the FAQ was last updated.
|
|
1962
2073
|
*/
|
|
1963
2074
|
UpdatedAt?: Timestamp;
|
|
1964
2075
|
S3Path?: S3Path;
|
|
@@ -1983,6 +2094,54 @@ declare namespace Kendra {
|
|
|
1983
2094
|
*/
|
|
1984
2095
|
LanguageCode?: LanguageCode;
|
|
1985
2096
|
}
|
|
2097
|
+
export interface DescribeFeaturedResultsSetRequest {
|
|
2098
|
+
/**
|
|
2099
|
+
* The identifier of the index used for featuring results.
|
|
2100
|
+
*/
|
|
2101
|
+
IndexId: IndexId;
|
|
2102
|
+
/**
|
|
2103
|
+
* The identifier of the set of featured results that you want to get information on.
|
|
2104
|
+
*/
|
|
2105
|
+
FeaturedResultsSetId: FeaturedResultsSetId;
|
|
2106
|
+
}
|
|
2107
|
+
export interface DescribeFeaturedResultsSetResponse {
|
|
2108
|
+
/**
|
|
2109
|
+
* The identifier of the set of featured results.
|
|
2110
|
+
*/
|
|
2111
|
+
FeaturedResultsSetId?: FeaturedResultsSetId;
|
|
2112
|
+
/**
|
|
2113
|
+
* The name for the set of featured results.
|
|
2114
|
+
*/
|
|
2115
|
+
FeaturedResultsSetName?: FeaturedResultsSetName;
|
|
2116
|
+
/**
|
|
2117
|
+
* The description for the set of featured results.
|
|
2118
|
+
*/
|
|
2119
|
+
Description?: FeaturedResultsSetDescription;
|
|
2120
|
+
/**
|
|
2121
|
+
* The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
|
|
2122
|
+
*/
|
|
2123
|
+
Status?: FeaturedResultsSetStatus;
|
|
2124
|
+
/**
|
|
2125
|
+
* The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
|
|
2126
|
+
*/
|
|
2127
|
+
QueryTexts?: QueryTextList;
|
|
2128
|
+
/**
|
|
2129
|
+
* The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.
|
|
2130
|
+
*/
|
|
2131
|
+
FeaturedDocumentsWithMetadata?: FeaturedDocumentWithMetadataList;
|
|
2132
|
+
/**
|
|
2133
|
+
* The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.
|
|
2134
|
+
*/
|
|
2135
|
+
FeaturedDocumentsMissing?: FeaturedDocumentMissingList;
|
|
2136
|
+
/**
|
|
2137
|
+
* The timestamp when the set of featured results was last updated.
|
|
2138
|
+
*/
|
|
2139
|
+
LastUpdatedTimestamp?: Long;
|
|
2140
|
+
/**
|
|
2141
|
+
* The Unix timestamp when the set of the featured results was created.
|
|
2142
|
+
*/
|
|
2143
|
+
CreationTimestamp?: Long;
|
|
2144
|
+
}
|
|
1986
2145
|
export interface DescribeIndexRequest {
|
|
1987
2146
|
/**
|
|
1988
2147
|
* The identifier of the index you want to get information on.
|
|
@@ -2019,11 +2178,11 @@ declare namespace Kendra {
|
|
|
2019
2178
|
*/
|
|
2020
2179
|
Description?: Description;
|
|
2021
2180
|
/**
|
|
2022
|
-
* The Unix
|
|
2181
|
+
* The Unix timestamp when the index was created.
|
|
2023
2182
|
*/
|
|
2024
2183
|
CreatedAt?: Timestamp;
|
|
2025
2184
|
/**
|
|
2026
|
-
* The Unix
|
|
2185
|
+
* The Unix when the index was last updated.
|
|
2027
2186
|
*/
|
|
2028
2187
|
UpdatedAt?: Timestamp;
|
|
2029
2188
|
/**
|
|
@@ -2083,7 +2242,7 @@ declare namespace Kendra {
|
|
|
2083
2242
|
*/
|
|
2084
2243
|
GroupId?: GroupId;
|
|
2085
2244
|
/**
|
|
2086
|
-
* Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups: Status
|
|
2245
|
+
* Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups: Status—the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED. Last updated—the last date-time an action was updated. Received—the last date-time an action was received or submitted. Ordering ID—the latest action that should process and apply after other actions. Failure reason—the reason an action could not be processed.
|
|
2087
2246
|
*/
|
|
2088
2247
|
GroupOrderingIdSummaries?: GroupOrderingIdSummaries;
|
|
2089
2248
|
}
|
|
@@ -2123,11 +2282,11 @@ declare namespace Kendra {
|
|
|
2123
2282
|
*/
|
|
2124
2283
|
ErrorMessage?: ErrorMessage;
|
|
2125
2284
|
/**
|
|
2126
|
-
* The
|
|
2285
|
+
* The Unix timestamp when a block list for query suggestions was created.
|
|
2127
2286
|
*/
|
|
2128
2287
|
CreatedAt?: Timestamp;
|
|
2129
2288
|
/**
|
|
2130
|
-
* The
|
|
2289
|
+
* The Unix timestamp when a block list for query suggestions was last updated.
|
|
2131
2290
|
*/
|
|
2132
2291
|
UpdatedAt?: Timestamp;
|
|
2133
2292
|
/**
|
|
@@ -2179,11 +2338,11 @@ declare namespace Kendra {
|
|
|
2179
2338
|
*/
|
|
2180
2339
|
MinimumQueryCount?: MinimumQueryCount;
|
|
2181
2340
|
/**
|
|
2182
|
-
* The
|
|
2341
|
+
* The Unix timestamp when query suggestions for an index was last updated.
|
|
2183
2342
|
*/
|
|
2184
2343
|
LastSuggestionsBuildTime?: Timestamp;
|
|
2185
2344
|
/**
|
|
2186
|
-
* The
|
|
2345
|
+
* The Unix timestamp when query suggestions for an index was last cleared. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.
|
|
2187
2346
|
*/
|
|
2188
2347
|
LastClearTime?: Timestamp;
|
|
2189
2348
|
/**
|
|
@@ -2227,11 +2386,11 @@ declare namespace Kendra {
|
|
|
2227
2386
|
*/
|
|
2228
2387
|
ErrorMessage?: ErrorMessage;
|
|
2229
2388
|
/**
|
|
2230
|
-
* The Unix
|
|
2389
|
+
* The Unix timestamp when the thesaurus was created.
|
|
2231
2390
|
*/
|
|
2232
2391
|
CreatedAt?: Timestamp;
|
|
2233
2392
|
/**
|
|
2234
|
-
* The Unix
|
|
2393
|
+
* The Unix timestamp when the thesaurus was last updated.
|
|
2235
2394
|
*/
|
|
2236
2395
|
UpdatedAt?: Timestamp;
|
|
2237
2396
|
/**
|
|
@@ -2400,7 +2559,7 @@ declare namespace Kendra {
|
|
|
2400
2559
|
*/
|
|
2401
2560
|
Count?: Integer;
|
|
2402
2561
|
/**
|
|
2403
|
-
* Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet. For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
|
|
2562
|
+
* Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet. For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
|
|
2404
2563
|
*/
|
|
2405
2564
|
FacetResults?: FacetResultList;
|
|
2406
2565
|
}
|
|
@@ -2566,7 +2725,7 @@ declare namespace Kendra {
|
|
|
2566
2725
|
*/
|
|
2567
2726
|
Id?: ExperienceId;
|
|
2568
2727
|
/**
|
|
2569
|
-
* The
|
|
2728
|
+
* The Unix timestamp when your Amazon Kendra experience was created.
|
|
2570
2729
|
*/
|
|
2571
2730
|
CreatedAt?: Timestamp;
|
|
2572
2731
|
/**
|
|
@@ -2646,11 +2805,11 @@ declare namespace Kendra {
|
|
|
2646
2805
|
*/
|
|
2647
2806
|
Status?: FaqStatus;
|
|
2648
2807
|
/**
|
|
2649
|
-
* The
|
|
2808
|
+
* The Unix timestamp when the FAQ was created.
|
|
2650
2809
|
*/
|
|
2651
2810
|
CreatedAt?: Timestamp;
|
|
2652
2811
|
/**
|
|
2653
|
-
* The
|
|
2812
|
+
* The Unix timestamp when the FAQ was last updated.
|
|
2654
2813
|
*/
|
|
2655
2814
|
UpdatedAt?: Timestamp;
|
|
2656
2815
|
/**
|
|
@@ -2663,6 +2822,130 @@ declare namespace Kendra {
|
|
|
2663
2822
|
LanguageCode?: LanguageCode;
|
|
2664
2823
|
}
|
|
2665
2824
|
export type FaqSummaryItems = FaqSummary[];
|
|
2825
|
+
export interface FeaturedDocument {
|
|
2826
|
+
/**
|
|
2827
|
+
* The identifier of the document to feature in the search results. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.
|
|
2828
|
+
*/
|
|
2829
|
+
Id?: DocumentId;
|
|
2830
|
+
}
|
|
2831
|
+
export type FeaturedDocumentList = FeaturedDocument[];
|
|
2832
|
+
export interface FeaturedDocumentMissing {
|
|
2833
|
+
/**
|
|
2834
|
+
* The identifier of the document that doesn't exist but you have specified as a featured document.
|
|
2835
|
+
*/
|
|
2836
|
+
Id?: DocumentId;
|
|
2837
|
+
}
|
|
2838
|
+
export type FeaturedDocumentMissingList = FeaturedDocumentMissing[];
|
|
2839
|
+
export interface FeaturedDocumentWithMetadata {
|
|
2840
|
+
/**
|
|
2841
|
+
* The identifier of the featured document with its metadata. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.
|
|
2842
|
+
*/
|
|
2843
|
+
Id?: DocumentId;
|
|
2844
|
+
/**
|
|
2845
|
+
* The main title of the featured document.
|
|
2846
|
+
*/
|
|
2847
|
+
Title?: String;
|
|
2848
|
+
/**
|
|
2849
|
+
* The source URI location of the featured document.
|
|
2850
|
+
*/
|
|
2851
|
+
URI?: Url;
|
|
2852
|
+
}
|
|
2853
|
+
export type FeaturedDocumentWithMetadataList = FeaturedDocumentWithMetadata[];
|
|
2854
|
+
export interface FeaturedResultsItem {
|
|
2855
|
+
/**
|
|
2856
|
+
* The identifier of the featured result.
|
|
2857
|
+
*/
|
|
2858
|
+
Id?: ResultId;
|
|
2859
|
+
/**
|
|
2860
|
+
* The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.
|
|
2861
|
+
*/
|
|
2862
|
+
Type?: QueryResultType;
|
|
2863
|
+
/**
|
|
2864
|
+
* One or more additional attributes associated with the featured result.
|
|
2865
|
+
*/
|
|
2866
|
+
AdditionalAttributes?: AdditionalResultAttributeList;
|
|
2867
|
+
/**
|
|
2868
|
+
* The identifier of the featured document.
|
|
2869
|
+
*/
|
|
2870
|
+
DocumentId?: DocumentId;
|
|
2871
|
+
DocumentTitle?: TextWithHighlights;
|
|
2872
|
+
DocumentExcerpt?: TextWithHighlights;
|
|
2873
|
+
/**
|
|
2874
|
+
* The source URI location of the featured document.
|
|
2875
|
+
*/
|
|
2876
|
+
DocumentURI?: Url;
|
|
2877
|
+
/**
|
|
2878
|
+
* An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
|
|
2879
|
+
*/
|
|
2880
|
+
DocumentAttributes?: DocumentAttributeList;
|
|
2881
|
+
/**
|
|
2882
|
+
* A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.
|
|
2883
|
+
*/
|
|
2884
|
+
FeedbackToken?: FeedbackToken;
|
|
2885
|
+
}
|
|
2886
|
+
export type FeaturedResultsItemList = FeaturedResultsItem[];
|
|
2887
|
+
export interface FeaturedResultsSet {
|
|
2888
|
+
/**
|
|
2889
|
+
* The identifier of the set of featured results.
|
|
2890
|
+
*/
|
|
2891
|
+
FeaturedResultsSetId?: FeaturedResultsSetId;
|
|
2892
|
+
/**
|
|
2893
|
+
* The name for the set of featured results.
|
|
2894
|
+
*/
|
|
2895
|
+
FeaturedResultsSetName?: FeaturedResultsSetName;
|
|
2896
|
+
/**
|
|
2897
|
+
* The description for the set of featured results.
|
|
2898
|
+
*/
|
|
2899
|
+
Description?: FeaturedResultsSetDescription;
|
|
2900
|
+
/**
|
|
2901
|
+
* The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
|
|
2902
|
+
*/
|
|
2903
|
+
Status?: FeaturedResultsSetStatus;
|
|
2904
|
+
/**
|
|
2905
|
+
* The list of queries for featuring results. Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
|
|
2906
|
+
*/
|
|
2907
|
+
QueryTexts?: QueryTextList;
|
|
2908
|
+
/**
|
|
2909
|
+
* The list of document IDs for the documents you want to feature at the top of the search results page. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console. You can add up to four featured documents. You can request to increase this limit by contacting Support. Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
|
|
2910
|
+
*/
|
|
2911
|
+
FeaturedDocuments?: FeaturedDocumentList;
|
|
2912
|
+
/**
|
|
2913
|
+
* The Unix timestamp when the set of featured results was last updated.
|
|
2914
|
+
*/
|
|
2915
|
+
LastUpdatedTimestamp?: Long;
|
|
2916
|
+
/**
|
|
2917
|
+
* The Unix timestamp when the set of featured results was created.
|
|
2918
|
+
*/
|
|
2919
|
+
CreationTimestamp?: Long;
|
|
2920
|
+
}
|
|
2921
|
+
export type FeaturedResultsSetDescription = string;
|
|
2922
|
+
export type FeaturedResultsSetId = string;
|
|
2923
|
+
export type FeaturedResultsSetIdList = FeaturedResultsSetId[];
|
|
2924
|
+
export type FeaturedResultsSetName = string;
|
|
2925
|
+
export type FeaturedResultsSetStatus = "ACTIVE"|"INACTIVE"|string;
|
|
2926
|
+
export interface FeaturedResultsSetSummary {
|
|
2927
|
+
/**
|
|
2928
|
+
* The identifier of the set of featured results.
|
|
2929
|
+
*/
|
|
2930
|
+
FeaturedResultsSetId?: FeaturedResultsSetId;
|
|
2931
|
+
/**
|
|
2932
|
+
* The name for the set of featured results.
|
|
2933
|
+
*/
|
|
2934
|
+
FeaturedResultsSetName?: FeaturedResultsSetName;
|
|
2935
|
+
/**
|
|
2936
|
+
* The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
|
|
2937
|
+
*/
|
|
2938
|
+
Status?: FeaturedResultsSetStatus;
|
|
2939
|
+
/**
|
|
2940
|
+
* The Unix timestamp when the set of featured results was last updated.
|
|
2941
|
+
*/
|
|
2942
|
+
LastUpdatedTimestamp?: Long;
|
|
2943
|
+
/**
|
|
2944
|
+
* The Unix timestamp when the set of featured results was created.
|
|
2945
|
+
*/
|
|
2946
|
+
CreationTimestamp?: Long;
|
|
2947
|
+
}
|
|
2948
|
+
export type FeaturedResultsSetSummaryItems = FeaturedResultsSetSummary[];
|
|
2666
2949
|
export type FeedbackToken = string;
|
|
2667
2950
|
export type FileSystemId = string;
|
|
2668
2951
|
export type FolderId = string;
|
|
@@ -2746,7 +3029,7 @@ declare namespace Kendra {
|
|
|
2746
3029
|
}
|
|
2747
3030
|
export interface GetSnapshotsResponse {
|
|
2748
3031
|
/**
|
|
2749
|
-
* The
|
|
3032
|
+
* The Unix timestamp for the beginning and end of the time window for the search metrics data.
|
|
2750
3033
|
*/
|
|
2751
3034
|
SnapShotTimeFilter?: TimeRange;
|
|
2752
3035
|
/**
|
|
@@ -2935,11 +3218,11 @@ declare namespace Kendra {
|
|
|
2935
3218
|
*/
|
|
2936
3219
|
Status?: PrincipalMappingStatus;
|
|
2937
3220
|
/**
|
|
2938
|
-
* The
|
|
3221
|
+
* The Unix timestamp when an action was last updated. An action can be a PUT or DELETE action for mapping users to their groups.
|
|
2939
3222
|
*/
|
|
2940
3223
|
LastUpdatedAt?: Timestamp;
|
|
2941
3224
|
/**
|
|
2942
|
-
* The
|
|
3225
|
+
* The Unix timestamp when an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.
|
|
2943
3226
|
*/
|
|
2944
3227
|
ReceivedAt?: Timestamp;
|
|
2945
3228
|
/**
|
|
@@ -3024,7 +3307,7 @@ declare namespace Kendra {
|
|
|
3024
3307
|
*/
|
|
3025
3308
|
CreatedAt: Timestamp;
|
|
3026
3309
|
/**
|
|
3027
|
-
* The Unix timestamp when the index was last updated
|
|
3310
|
+
* The Unix timestamp when the index was last updated.
|
|
3028
3311
|
*/
|
|
3029
3312
|
UpdatedAt: Timestamp;
|
|
3030
3313
|
/**
|
|
@@ -3364,6 +3647,30 @@ declare namespace Kendra {
|
|
|
3364
3647
|
*/
|
|
3365
3648
|
FaqSummaryItems?: FaqSummaryItems;
|
|
3366
3649
|
}
|
|
3650
|
+
export interface ListFeaturedResultsSetsRequest {
|
|
3651
|
+
/**
|
|
3652
|
+
* The identifier of the index used for featuring results.
|
|
3653
|
+
*/
|
|
3654
|
+
IndexId: IndexId;
|
|
3655
|
+
/**
|
|
3656
|
+
* If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.
|
|
3657
|
+
*/
|
|
3658
|
+
NextToken?: NextToken;
|
|
3659
|
+
/**
|
|
3660
|
+
* The maximum number of featured results sets to return.
|
|
3661
|
+
*/
|
|
3662
|
+
MaxResults?: MaxResultsIntegerForListFeaturedResultsSetsRequest;
|
|
3663
|
+
}
|
|
3664
|
+
export interface ListFeaturedResultsSetsResponse {
|
|
3665
|
+
/**
|
|
3666
|
+
* An array of summary information for one or more featured results sets.
|
|
3667
|
+
*/
|
|
3668
|
+
FeaturedResultsSetSummaryItems?: FeaturedResultsSetSummaryItems;
|
|
3669
|
+
/**
|
|
3670
|
+
* If the response is truncated, Amazon Kendra returns a pagination token in the response.
|
|
3671
|
+
*/
|
|
3672
|
+
NextToken?: NextToken;
|
|
3673
|
+
}
|
|
3367
3674
|
export interface ListGroupsOlderThanOrderingIdRequest {
|
|
3368
3675
|
/**
|
|
3369
3676
|
* The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.
|
|
@@ -3487,6 +3794,7 @@ declare namespace Kendra {
|
|
|
3487
3794
|
export type MaxResultsIntegerForListEntityPersonasRequest = number;
|
|
3488
3795
|
export type MaxResultsIntegerForListExperiencesRequest = number;
|
|
3489
3796
|
export type MaxResultsIntegerForListFaqsRequest = number;
|
|
3797
|
+
export type MaxResultsIntegerForListFeaturedResultsSetsRequest = number;
|
|
3490
3798
|
export type MaxResultsIntegerForListIndicesRequest = number;
|
|
3491
3799
|
export type MaxResultsIntegerForListPrincipalsRequest = number;
|
|
3492
3800
|
export type MaxResultsIntegerForListQuerySuggestionsBlockLists = number;
|
|
@@ -3589,11 +3897,11 @@ declare namespace Kendra {
|
|
|
3589
3897
|
*/
|
|
3590
3898
|
Persona?: Persona;
|
|
3591
3899
|
/**
|
|
3592
|
-
* The
|
|
3900
|
+
* The Unix timestamp when the summary information was created.
|
|
3593
3901
|
*/
|
|
3594
3902
|
CreatedAt?: Timestamp;
|
|
3595
3903
|
/**
|
|
3596
|
-
* The
|
|
3904
|
+
* The Unix timestamp when the summary information was last updated.
|
|
3597
3905
|
*/
|
|
3598
3906
|
UpdatedAt?: Timestamp;
|
|
3599
3907
|
}
|
|
@@ -3657,7 +3965,7 @@ declare namespace Kendra {
|
|
|
3657
3965
|
*/
|
|
3658
3966
|
GroupMembers: GroupMembers;
|
|
3659
3967
|
/**
|
|
3660
|
-
* The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action. The ordering ID can be the
|
|
3968
|
+
* The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action. The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed. The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.
|
|
3661
3969
|
*/
|
|
3662
3970
|
OrderingId?: PrincipalOrderingId;
|
|
3663
3971
|
/**
|
|
@@ -3747,6 +4055,10 @@ declare namespace Kendra {
|
|
|
3747
4055
|
* A list of information related to suggested spell corrections for a query.
|
|
3748
4056
|
*/
|
|
3749
4057
|
SpellCorrectedQueries?: SpellCorrectedQueryList;
|
|
4058
|
+
/**
|
|
4059
|
+
* The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.
|
|
4060
|
+
*/
|
|
4061
|
+
FeaturedResultsItems?: FeaturedResultsItemList;
|
|
3750
4062
|
}
|
|
3751
4063
|
export type QueryResultFormat = "TABLE"|"TEXT"|string;
|
|
3752
4064
|
export interface QueryResultItem {
|
|
@@ -3818,11 +4130,11 @@ declare namespace Kendra {
|
|
|
3818
4130
|
*/
|
|
3819
4131
|
Status?: QuerySuggestionsBlockListStatus;
|
|
3820
4132
|
/**
|
|
3821
|
-
* The
|
|
4133
|
+
* The Unix timestamp when the block list was created.
|
|
3822
4134
|
*/
|
|
3823
4135
|
CreatedAt?: Timestamp;
|
|
3824
4136
|
/**
|
|
3825
|
-
* The
|
|
4137
|
+
* The Unix timestamp when the block list was last updated.
|
|
3826
4138
|
*/
|
|
3827
4139
|
UpdatedAt?: Timestamp;
|
|
3828
4140
|
/**
|
|
@@ -3834,6 +4146,7 @@ declare namespace Kendra {
|
|
|
3834
4146
|
export type QuerySuggestionsId = string;
|
|
3835
4147
|
export type QuerySuggestionsStatus = "ACTIVE"|"UPDATING"|string;
|
|
3836
4148
|
export type QueryText = string;
|
|
4149
|
+
export type QueryTextList = QueryText[];
|
|
3837
4150
|
export interface QuipConfiguration {
|
|
3838
4151
|
/**
|
|
3839
4152
|
* The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
|
|
@@ -3913,7 +4226,7 @@ declare namespace Kendra {
|
|
|
3913
4226
|
*/
|
|
3914
4227
|
ResultId: ResultId;
|
|
3915
4228
|
/**
|
|
3916
|
-
* Whether
|
|
4229
|
+
* Whether the document was relevant or not relevant to the search.
|
|
3917
4230
|
*/
|
|
3918
4231
|
RelevanceValue: RelevanceType;
|
|
3919
4232
|
}
|
|
@@ -3994,7 +4307,7 @@ declare namespace Kendra {
|
|
|
3994
4307
|
*/
|
|
3995
4308
|
ServerUrl: Url;
|
|
3996
4309
|
/**
|
|
3997
|
-
* The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys: authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token. consumerKey - The application public key generated when you created your Salesforce application. consumerSecret - The application private key generated when you created your Salesforce application. password - The password associated with the user logging in to the Salesforce instance. securityToken - The token associated with the user
|
|
4310
|
+
* The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys: authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token. consumerKey - The application public key generated when you created your Salesforce application. consumerSecret - The application private key generated when you created your Salesforce application. password - The password associated with the user logging in to the Salesforce instance. securityToken - The token associated with the user logging in to the Salesforce instance. username - The user name of the user logging in to the Salesforce instance.
|
|
3998
4311
|
*/
|
|
3999
4312
|
SecretArn: SecretArn;
|
|
4000
4313
|
/**
|
|
@@ -4141,7 +4454,7 @@ declare namespace Kendra {
|
|
|
4141
4454
|
*/
|
|
4142
4455
|
SeedUrls: SeedUrlList;
|
|
4143
4456
|
/**
|
|
4144
|
-
* You can choose one of the following modes: HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled. SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled. EVERYTHING – crawl the website host names with subdomains and other domains that the
|
|
4457
|
+
* You can choose one of the following modes: HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled. SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled. EVERYTHING – crawl the website host names with subdomains and other domains that the web pages link to. The default mode is set to HOST_ONLY.
|
|
4145
4458
|
*/
|
|
4146
4459
|
WebCrawlerMode?: WebCrawlerMode;
|
|
4147
4460
|
}
|
|
@@ -4248,7 +4561,7 @@ declare namespace Kendra {
|
|
|
4248
4561
|
*/
|
|
4249
4562
|
Urls: SharePointUrlList;
|
|
4250
4563
|
/**
|
|
4251
|
-
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance.
|
|
4564
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.
|
|
4252
4565
|
*/
|
|
4253
4566
|
SecretArn: SecretArn;
|
|
4254
4567
|
/**
|
|
@@ -4284,11 +4597,11 @@ declare namespace Kendra {
|
|
|
4284
4597
|
*/
|
|
4285
4598
|
DisableLocalGroups?: Boolean;
|
|
4286
4599
|
/**
|
|
4287
|
-
* The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection. You can
|
|
4600
|
+
* The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection. You can generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
|
|
4288
4601
|
*/
|
|
4289
4602
|
SslCertificateS3Path?: S3Path;
|
|
4290
4603
|
/**
|
|
4291
|
-
* Whether you want to connect to SharePoint using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret
|
|
4604
|
+
* Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.
|
|
4292
4605
|
*/
|
|
4293
4606
|
AuthenticationType?: SharePointOnlineAuthenticationType;
|
|
4294
4607
|
/**
|
|
@@ -4625,22 +4938,22 @@ declare namespace Kendra {
|
|
|
4625
4938
|
*/
|
|
4626
4939
|
Status?: ThesaurusStatus;
|
|
4627
4940
|
/**
|
|
4628
|
-
* The Unix
|
|
4941
|
+
* The Unix timestamp when the thesaurus was created.
|
|
4629
4942
|
*/
|
|
4630
4943
|
CreatedAt?: Timestamp;
|
|
4631
4944
|
/**
|
|
4632
|
-
* The Unix
|
|
4945
|
+
* The Unix timestamp when the thesaurus was last updated.
|
|
4633
4946
|
*/
|
|
4634
4947
|
UpdatedAt?: Timestamp;
|
|
4635
4948
|
}
|
|
4636
4949
|
export type ThesaurusSummaryItems = ThesaurusSummary[];
|
|
4637
4950
|
export interface TimeRange {
|
|
4638
4951
|
/**
|
|
4639
|
-
* The
|
|
4952
|
+
* The Unix timestamp for the beginning of the time range.
|
|
4640
4953
|
*/
|
|
4641
4954
|
StartTime?: Timestamp;
|
|
4642
4955
|
/**
|
|
4643
|
-
* The
|
|
4956
|
+
* The Unix timestamp for the end of the time range.
|
|
4644
4957
|
*/
|
|
4645
4958
|
EndTime?: Timestamp;
|
|
4646
4959
|
}
|
|
@@ -4757,6 +5070,42 @@ declare namespace Kendra {
|
|
|
4757
5070
|
*/
|
|
4758
5071
|
Description?: Description;
|
|
4759
5072
|
}
|
|
5073
|
+
export interface UpdateFeaturedResultsSetRequest {
|
|
5074
|
+
/**
|
|
5075
|
+
* The identifier of the index used for featuring results.
|
|
5076
|
+
*/
|
|
5077
|
+
IndexId: IndexId;
|
|
5078
|
+
/**
|
|
5079
|
+
* The identifier of the index used for featuring results.
|
|
5080
|
+
*/
|
|
5081
|
+
FeaturedResultsSetId: FeaturedResultsSetId;
|
|
5082
|
+
/**
|
|
5083
|
+
* A new name for the set of featured results.
|
|
5084
|
+
*/
|
|
5085
|
+
FeaturedResultsSetName?: FeaturedResultsSetName;
|
|
5086
|
+
/**
|
|
5087
|
+
* A new description for the set of featured results.
|
|
5088
|
+
*/
|
|
5089
|
+
Description?: FeaturedResultsSetDescription;
|
|
5090
|
+
/**
|
|
5091
|
+
* You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
|
|
5092
|
+
*/
|
|
5093
|
+
Status?: FeaturedResultsSetStatus;
|
|
5094
|
+
/**
|
|
5095
|
+
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
|
|
5096
|
+
*/
|
|
5097
|
+
QueryTexts?: QueryTextList;
|
|
5098
|
+
/**
|
|
5099
|
+
* A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see FeaturedResultsSet.
|
|
5100
|
+
*/
|
|
5101
|
+
FeaturedDocuments?: FeaturedDocumentList;
|
|
5102
|
+
}
|
|
5103
|
+
export interface UpdateFeaturedResultsSetResponse {
|
|
5104
|
+
/**
|
|
5105
|
+
* Information on the set of featured results. This includes the identifier of the featured results set, whether the featured results set is active or inactive, when the featured results set was last updated, and more.
|
|
5106
|
+
*/
|
|
5107
|
+
FeaturedResultsSet?: FeaturedResultsSet;
|
|
5108
|
+
}
|
|
4760
5109
|
export interface UpdateIndexRequest {
|
|
4761
5110
|
/**
|
|
4762
5111
|
* The identifier of the index you want to update.
|
|
@@ -4873,7 +5222,7 @@ declare namespace Kendra {
|
|
|
4873
5222
|
export type Url = string;
|
|
4874
5223
|
export interface Urls {
|
|
4875
5224
|
/**
|
|
4876
|
-
* Configuration of the seed or starting point URLs of the websites you want to crawl. You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the
|
|
5225
|
+
* Configuration of the seed or starting point URLs of the websites you want to crawl. You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to. You can list up to 100 seed URLs.
|
|
4877
5226
|
*/
|
|
4878
5227
|
SeedUrlConfiguration?: SeedUrlConfiguration;
|
|
4879
5228
|
/**
|
|
@@ -4903,7 +5252,7 @@ declare namespace Kendra {
|
|
|
4903
5252
|
export type UserContextPolicy = "ATTRIBUTE_FILTER"|"USER_TOKEN"|string;
|
|
4904
5253
|
export interface UserGroupResolutionConfiguration {
|
|
4905
5254
|
/**
|
|
4906
|
-
* The identity store provider (mode) you want to use to
|
|
5255
|
+
* The identity store provider (mode) you want to use to get users and groups. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.
|
|
4907
5256
|
*/
|
|
4908
5257
|
UserGroupResolutionMode: UserGroupResolutionMode;
|
|
4909
5258
|
}
|
|
@@ -4946,19 +5295,19 @@ declare namespace Kendra {
|
|
|
4946
5295
|
export type WarningMessage = string;
|
|
4947
5296
|
export interface WebCrawlerConfiguration {
|
|
4948
5297
|
/**
|
|
4949
|
-
* Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs. You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling. When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own
|
|
5298
|
+
* Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs. You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling. When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.
|
|
4950
5299
|
*/
|
|
4951
5300
|
Urls: Urls;
|
|
4952
5301
|
/**
|
|
4953
|
-
* Specifies the number of levels in a website that you want to crawl. The first level begins from the website seed or starting point URL. For example, if a website has
|
|
5302
|
+
* Specifies the number of levels in a website that you want to crawl. The first level begins from the website seed or starting point URL. For example, if a website has three levels—index level (the seed in this example), sections level, and subsections level—and you are only interested in crawling information up to the sections level (levels 0-1), you can set your depth to 1. The default crawl depth is set to 2.
|
|
4954
5303
|
*/
|
|
4955
5304
|
CrawlDepth?: CrawlDepth;
|
|
4956
5305
|
/**
|
|
4957
|
-
* The maximum number of URLs on a
|
|
5306
|
+
* The maximum number of URLs on a web page to include when crawling a website. This number is per web page. As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance. The default maximum links per page is 100.
|
|
4958
5307
|
*/
|
|
4959
5308
|
MaxLinksPerPage?: MaxLinksPerPage;
|
|
4960
5309
|
/**
|
|
4961
|
-
* The maximum size (in MB) of a
|
|
5310
|
+
* The maximum size (in MB) of a web page or attachment to crawl. Files larger than this size (in MB) are skipped/not crawled. The default maximum size of a web page or attachment is set to 50 MB.
|
|
4962
5311
|
*/
|
|
4963
5312
|
MaxContentSizePerPageInMegaBytes?: MaxContentSizePerPageInMegaBytes;
|
|
4964
5313
|
/**
|