aws-sdk 2.916.0 → 2.920.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 (45) hide show
  1. package/CHANGELOG.md +26 -1
  2. package/README.md +1 -1
  3. package/apis/autoscaling-2011-01-01.min.json +63 -60
  4. package/apis/datasync-2018-11-09.min.json +16 -15
  5. package/apis/devicefarm-2015-06-23.min.json +144 -92
  6. package/apis/docdb-2014-10-31.min.json +233 -65
  7. package/apis/docdb-2014-10-31.paginators.json +6 -0
  8. package/apis/ec2-2016-11-15.min.json +6 -0
  9. package/apis/fsx-2018-03-01.min.json +27 -24
  10. package/apis/iotevents-2018-07-27.min.json +715 -188
  11. package/apis/iotevents-data-2018-10-23.min.json +380 -1
  12. package/apis/iotsitewise-2019-12-02.min.json +65 -43
  13. package/apis/iotwireless-2020-11-22.min.json +210 -6
  14. package/apis/kendra-2019-02-03.min.json +351 -77
  15. package/apis/location-2020-11-19.min.json +677 -84
  16. package/apis/location-2020-11-19.paginators.json +12 -0
  17. package/apis/sns-2010-03-31.min.json +150 -13
  18. package/apis/sns-2010-03-31.paginators.json +12 -0
  19. package/clients/autoscaling.d.ts +55 -50
  20. package/clients/braket.d.ts +2 -2
  21. package/clients/datasync.d.ts +39 -34
  22. package/clients/devicefarm.d.ts +41 -10
  23. package/clients/docdb.d.ts +217 -4
  24. package/clients/ec2.d.ts +8 -0
  25. package/clients/ecs.d.ts +4 -4
  26. package/clients/fsx.d.ts +15 -2
  27. package/clients/iam.d.ts +1 -1
  28. package/clients/iotevents.d.ts +595 -11
  29. package/clients/ioteventsdata.d.ts +474 -9
  30. package/clients/iotsitewise.d.ts +34 -0
  31. package/clients/iotwireless.d.ts +126 -0
  32. package/clients/kendra.d.ts +410 -6
  33. package/clients/lightsail.d.ts +3 -3
  34. package/clients/location.d.ts +651 -77
  35. package/clients/polly.d.ts +1 -1
  36. package/clients/resourcegroups.d.ts +4 -4
  37. package/clients/servicediscovery.d.ts +41 -41
  38. package/clients/sns.d.ts +181 -4
  39. package/clients/sqs.d.ts +5 -5
  40. package/dist/aws-sdk-core-react-native.js +1 -1
  41. package/dist/aws-sdk-react-native.js +17 -17
  42. package/dist/aws-sdk.js +378 -168
  43. package/dist/aws-sdk.min.js +68 -68
  44. package/lib/core.js +1 -1
  45. package/package.json +1 -1
@@ -27,6 +27,14 @@ declare class Kendra extends Service {
27
27
  * Adds one or more documents to an index. The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.
28
28
  */
29
29
  batchPutDocument(callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
30
+ /**
31
+ * Clears existing query suggestions from an index. This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
32
+ */
33
+ clearQuerySuggestions(params: Kendra.Types.ClearQuerySuggestionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
34
+ /**
35
+ * Clears existing query suggestions from an index. This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
36
+ */
37
+ clearQuerySuggestions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
30
38
  /**
31
39
  * Creates a data source that you use to with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
32
40
  */
@@ -51,6 +59,14 @@ declare class Kendra extends Service {
51
59
  * Creates a new Amazon Kendra index. Index creation is an asynchronous operation. 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 operation or using one of the supported data sources.
52
60
  */
53
61
  createIndex(callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
62
+ /**
63
+ * Creates a block list to exlcude certain queries from suggestions. Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
64
+ */
65
+ createQuerySuggestionsBlockList(params: Kendra.Types.CreateQuerySuggestionsBlockListRequest, callback?: (err: AWSError, data: Kendra.Types.CreateQuerySuggestionsBlockListResponse) => void): Request<Kendra.Types.CreateQuerySuggestionsBlockListResponse, AWSError>;
66
+ /**
67
+ * Creates a block list to exlcude certain queries from suggestions. Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
68
+ */
69
+ createQuerySuggestionsBlockList(callback?: (err: AWSError, data: Kendra.Types.CreateQuerySuggestionsBlockListResponse) => void): Request<Kendra.Types.CreateQuerySuggestionsBlockListResponse, AWSError>;
54
70
  /**
55
71
  * Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
56
72
  */
@@ -83,6 +99,14 @@ declare class Kendra extends Service {
83
99
  * Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.
84
100
  */
85
101
  deleteIndex(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
102
+ /**
103
+ * Deletes a block list used for query suggestions for an index. A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
104
+ */
105
+ deleteQuerySuggestionsBlockList(params: Kendra.Types.DeleteQuerySuggestionsBlockListRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
106
+ /**
107
+ * Deletes a block list used for query suggestions for an index. A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
108
+ */
109
+ deleteQuerySuggestionsBlockList(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
86
110
  /**
87
111
  * Deletes an existing Amazon Kendra thesaurus.
88
112
  */
@@ -115,6 +139,22 @@ declare class Kendra extends Service {
115
139
  * Describes an existing Amazon Kendra index
116
140
  */
117
141
  describeIndex(callback?: (err: AWSError, data: Kendra.Types.DescribeIndexResponse) => void): Request<Kendra.Types.DescribeIndexResponse, AWSError>;
142
+ /**
143
+ * Describes a block list used for query suggestions for an index. This is used to check the current settings that are applied to a block list.
144
+ */
145
+ describeQuerySuggestionsBlockList(params: Kendra.Types.DescribeQuerySuggestionsBlockListRequest, callback?: (err: AWSError, data: Kendra.Types.DescribeQuerySuggestionsBlockListResponse) => void): Request<Kendra.Types.DescribeQuerySuggestionsBlockListResponse, AWSError>;
146
+ /**
147
+ * Describes a block list used for query suggestions for an index. This is used to check the current settings that are applied to a block list.
148
+ */
149
+ describeQuerySuggestionsBlockList(callback?: (err: AWSError, data: Kendra.Types.DescribeQuerySuggestionsBlockListResponse) => void): Request<Kendra.Types.DescribeQuerySuggestionsBlockListResponse, AWSError>;
150
+ /**
151
+ * Describes the settings of query suggestions for an index. This is used to check the current settings applied to query suggestions.
152
+ */
153
+ describeQuerySuggestionsConfig(params: Kendra.Types.DescribeQuerySuggestionsConfigRequest, callback?: (err: AWSError, data: Kendra.Types.DescribeQuerySuggestionsConfigResponse) => void): Request<Kendra.Types.DescribeQuerySuggestionsConfigResponse, AWSError>;
154
+ /**
155
+ * Describes the settings of query suggestions for an index. This is used to check the current settings applied to query suggestions.
156
+ */
157
+ describeQuerySuggestionsConfig(callback?: (err: AWSError, data: Kendra.Types.DescribeQuerySuggestionsConfigResponse) => void): Request<Kendra.Types.DescribeQuerySuggestionsConfigResponse, AWSError>;
118
158
  /**
119
159
  * Describes an existing Amazon Kendra thesaurus.
120
160
  */
@@ -123,6 +163,14 @@ declare class Kendra extends Service {
123
163
  * Describes an existing Amazon Kendra thesaurus.
124
164
  */
125
165
  describeThesaurus(callback?: (err: AWSError, data: Kendra.Types.DescribeThesaurusResponse) => void): Request<Kendra.Types.DescribeThesaurusResponse, AWSError>;
166
+ /**
167
+ * Fetches the queries that are suggested to your users.
168
+ */
169
+ getQuerySuggestions(params: Kendra.Types.GetQuerySuggestionsRequest, callback?: (err: AWSError, data: Kendra.Types.GetQuerySuggestionsResponse) => void): Request<Kendra.Types.GetQuerySuggestionsResponse, AWSError>;
170
+ /**
171
+ * Fetches the queries that are suggested to your users.
172
+ */
173
+ getQuerySuggestions(callback?: (err: AWSError, data: Kendra.Types.GetQuerySuggestionsResponse) => void): Request<Kendra.Types.GetQuerySuggestionsResponse, AWSError>;
126
174
  /**
127
175
  * Gets statistics about synchronizing Amazon Kendra with a data source.
128
176
  */
@@ -155,6 +203,14 @@ declare class Kendra extends Service {
155
203
  * Lists the Amazon Kendra indexes that you have created.
156
204
  */
157
205
  listIndices(callback?: (err: AWSError, data: Kendra.Types.ListIndicesResponse) => void): Request<Kendra.Types.ListIndicesResponse, AWSError>;
206
+ /**
207
+ * Lists the block lists used for query suggestions for an index. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
208
+ */
209
+ listQuerySuggestionsBlockLists(params: Kendra.Types.ListQuerySuggestionsBlockListsRequest, callback?: (err: AWSError, data: Kendra.Types.ListQuerySuggestionsBlockListsResponse) => void): Request<Kendra.Types.ListQuerySuggestionsBlockListsResponse, AWSError>;
210
+ /**
211
+ * Lists the block lists used for query suggestions for an index. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
212
+ */
213
+ listQuerySuggestionsBlockLists(callback?: (err: AWSError, data: Kendra.Types.ListQuerySuggestionsBlockListsResponse) => void): Request<Kendra.Types.ListQuerySuggestionsBlockListsResponse, AWSError>;
158
214
  /**
159
215
  * Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
160
216
  */
@@ -235,6 +291,22 @@ declare class Kendra extends Service {
235
291
  * Updates an existing Amazon Kendra index.
236
292
  */
237
293
  updateIndex(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
294
+ /**
295
+ * Updates a block list used for query suggestions for an index. Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately. If a block list is updating, then you need to wait for the first update to finish before submitting another update. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
296
+ */
297
+ updateQuerySuggestionsBlockList(params: Kendra.Types.UpdateQuerySuggestionsBlockListRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
298
+ /**
299
+ * Updates a block list used for query suggestions for an index. Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately. If a block list is updating, then you need to wait for the first update to finish before submitting another update. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
300
+ */
301
+ updateQuerySuggestionsBlockList(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
302
+ /**
303
+ * Updates the settings of query suggestions for an index. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update. Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index. You can still enable/disable query suggestions at any time.
304
+ */
305
+ updateQuerySuggestionsConfig(params: Kendra.Types.UpdateQuerySuggestionsConfigRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
306
+ /**
307
+ * Updates the settings of query suggestions for an index. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update. Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index. You can still enable/disable query suggestions at any time.
308
+ */
309
+ updateQuerySuggestionsConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
238
310
  /**
239
311
  * Updates a thesaurus file associated with an index.
240
312
  */
@@ -365,7 +437,7 @@ declare namespace Kendra {
365
437
  */
366
438
  RoleArn?: RoleArn;
367
439
  /**
368
- * One or more documents to add to the index. Documents have the following file size limits. 5 MB total size for inline documents 50 MB total size for files from an S3 bucket 5 MB extracted text for any file For more information about file size and transaction per second quotas, see Quotas.
440
+ * One or more documents to add to the index. Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job. Documents have the following file size limits. 5 MB total size for inline documents 50 MB total size for files from an S3 bucket 5 MB extracted text for any file For more information about file size and transaction per second quotas, see Quotas.
369
441
  */
370
442
  Documents: DocumentList;
371
443
  }
@@ -404,6 +476,12 @@ declare namespace Kendra {
404
476
  }
405
477
  export type ChangeDetectingColumns = ColumnName[];
406
478
  export type ClaimRegex = string;
479
+ export interface ClearQuerySuggestionsRequest {
480
+ /**
481
+ * The identifier of the index you want to clear query suggestions from.
482
+ */
483
+ IndexId: IndexId;
484
+ }
407
485
  export interface ClickFeedback {
408
486
  /**
409
487
  * The unique identifier of the search result that was clicked.
@@ -743,6 +821,42 @@ declare namespace Kendra {
743
821
  */
744
822
  Id?: IndexId;
745
823
  }
824
+ export interface CreateQuerySuggestionsBlockListRequest {
825
+ /**
826
+ * The identifier of the index you want to create a query suggestions block list for.
827
+ */
828
+ IndexId: IndexId;
829
+ /**
830
+ * A user friendly name for the block list. For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.
831
+ */
832
+ Name: QuerySuggestionsBlockListName;
833
+ /**
834
+ * A user-friendly 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."
835
+ */
836
+ Description?: Description;
837
+ /**
838
+ * The S3 path to your block list text file in your S3 bucket. Each block word or phrase should be on a separate line in a text file. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
839
+ */
840
+ SourceS3Path: S3Path;
841
+ /**
842
+ * A token that you provide to identify the request to create a query suggestions block list.
843
+ */
844
+ ClientToken?: ClientTokenName;
845
+ /**
846
+ * The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket. You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
847
+ */
848
+ RoleArn: RoleArn;
849
+ /**
850
+ * A tag that you can assign to a block list that categorizes the block list.
851
+ */
852
+ Tags?: TagList;
853
+ }
854
+ export interface CreateQuerySuggestionsBlockListResponse {
855
+ /**
856
+ * The unique identifier of the created block list.
857
+ */
858
+ Id?: QuerySuggestionsBlockListId;
859
+ }
746
860
  export interface CreateThesaurusRequest {
747
861
  /**
748
862
  * The unique identifier of the index for the new thesaurus.
@@ -889,9 +1003,9 @@ declare namespace Kendra {
889
1003
  */
890
1004
  DataSourceId: DataSourceId;
891
1005
  /**
892
- * The ID of the sync job that is running on the data source.
1006
+ * The ID of the sync job that is running on the data source. If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job. If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.
893
1007
  */
894
- DataSourceSyncJobId: DataSourceSyncJobId;
1008
+ DataSourceSyncJobId?: DataSourceSyncJobId;
895
1009
  }
896
1010
  export interface DataSourceSyncJobMetrics {
897
1011
  /**
@@ -995,6 +1109,16 @@ declare namespace Kendra {
995
1109
  */
996
1110
  Id: IndexId;
997
1111
  }
1112
+ export interface DeleteQuerySuggestionsBlockListRequest {
1113
+ /**
1114
+ * The identifier of the you want to delete a block list from.
1115
+ */
1116
+ IndexId: IndexId;
1117
+ /**
1118
+ * The unique identifier of the block list that needs to be deleted.
1119
+ */
1120
+ Id: QuerySuggestionsBlockListId;
1121
+ }
998
1122
  export interface DeleteThesaurusRequest {
999
1123
  /**
1000
1124
  * The identifier of the thesaurus to delete.
@@ -1186,6 +1310,110 @@ declare namespace Kendra {
1186
1310
  */
1187
1311
  UserContextPolicy?: UserContextPolicy;
1188
1312
  }
1313
+ export interface DescribeQuerySuggestionsBlockListRequest {
1314
+ /**
1315
+ * The identifier of the index for the block list.
1316
+ */
1317
+ IndexId: IndexId;
1318
+ /**
1319
+ * The unique identifier of the block list.
1320
+ */
1321
+ Id: QuerySuggestionsBlockListId;
1322
+ }
1323
+ export interface DescribeQuerySuggestionsBlockListResponse {
1324
+ /**
1325
+ * Shows the identifier of the index for the block list.
1326
+ */
1327
+ IndexId?: IndexId;
1328
+ /**
1329
+ * Shows the unique identifier of the block list.
1330
+ */
1331
+ Id?: QuerySuggestionsBlockListId;
1332
+ /**
1333
+ * Shows the name of the block list.
1334
+ */
1335
+ Name?: QuerySuggestionsBlockListName;
1336
+ /**
1337
+ * Shows the description for the block list.
1338
+ */
1339
+ Description?: Description;
1340
+ /**
1341
+ * Shows whether the current status of the block list is ACTIVE or INACTIVE.
1342
+ */
1343
+ Status?: QuerySuggestionsBlockListStatus;
1344
+ /**
1345
+ * Shows the error message with details when there are issues in processing the block list.
1346
+ */
1347
+ ErrorMessage?: ErrorMessage;
1348
+ /**
1349
+ * Shows the date-time a block list for query suggestions was last created.
1350
+ */
1351
+ CreatedAt?: Timestamp;
1352
+ /**
1353
+ * Shows the date-time a block list for query suggestions was last updated.
1354
+ */
1355
+ UpdatedAt?: Timestamp;
1356
+ /**
1357
+ * Shows the current S3 path to your block list text file in your S3 bucket. Each block word or phrase should be on a separate line in a text file. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
1358
+ */
1359
+ SourceS3Path?: S3Path;
1360
+ /**
1361
+ * Shows the current number of valid, non-empty words or phrases in the block list text file.
1362
+ */
1363
+ ItemCount?: Integer;
1364
+ /**
1365
+ * Shows the current size of the block list text file in S3.
1366
+ */
1367
+ FileSizeBytes?: Long;
1368
+ /**
1369
+ * Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3. The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
1370
+ */
1371
+ RoleArn?: RoleArn;
1372
+ }
1373
+ export interface DescribeQuerySuggestionsConfigRequest {
1374
+ /**
1375
+ * The identifier of the index you want to describe query suggestions settings for.
1376
+ */
1377
+ IndexId: IndexId;
1378
+ }
1379
+ export interface DescribeQuerySuggestionsConfigResponse {
1380
+ /**
1381
+ * Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode. By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig operation.
1382
+ */
1383
+ Mode?: Mode;
1384
+ /**
1385
+ * Shows whether the status of query suggestions settings is currently Active or Updating. Active means the current settings apply and Updating means your changed settings are in the process of applying.
1386
+ */
1387
+ Status?: QuerySuggestionsStatus;
1388
+ /**
1389
+ * Shows how recent your queries are in your query log time window (in days).
1390
+ */
1391
+ QueryLogLookBackWindowInDays?: Integer;
1392
+ /**
1393
+ * Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.
1394
+ */
1395
+ IncludeQueriesWithoutUserInformation?: ObjectBoolean;
1396
+ /**
1397
+ * Shows the minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
1398
+ */
1399
+ MinimumNumberOfQueryingUsers?: MinimumNumberOfQueryingUsers;
1400
+ /**
1401
+ * Shows the minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
1402
+ */
1403
+ MinimumQueryCount?: MinimumQueryCount;
1404
+ /**
1405
+ * Shows the date-time query suggestions for an index was last updated.
1406
+ */
1407
+ LastSuggestionsBuildTime?: Timestamp;
1408
+ /**
1409
+ * Shows the date-time 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.
1410
+ */
1411
+ LastClearTime?: Timestamp;
1412
+ /**
1413
+ * Shows the current total count of query suggestions for an index. This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.
1414
+ */
1415
+ TotalSuggestionsCount?: Integer;
1416
+ }
1189
1417
  export interface DescribeThesaurusRequest {
1190
1418
  /**
1191
1419
  * The identifier of the thesaurus to describe.
@@ -1424,6 +1652,30 @@ declare namespace Kendra {
1424
1652
  }
1425
1653
  export type FaqSummaryItems = FaqSummary[];
1426
1654
  export type FeedbackToken = string;
1655
+ export interface GetQuerySuggestionsRequest {
1656
+ /**
1657
+ * The identifier of the index you want to get query suggestions from.
1658
+ */
1659
+ IndexId: IndexId;
1660
+ /**
1661
+ * The text of a user's query to generate query suggestions. A query is suggested if the query prefix matches what a user starts to type as their query. Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.
1662
+ */
1663
+ QueryText: SuggestionQueryText;
1664
+ /**
1665
+ * The maximum number of query suggestions you want to show to your users.
1666
+ */
1667
+ MaxSuggestionsCount?: Integer;
1668
+ }
1669
+ export interface GetQuerySuggestionsResponse {
1670
+ /**
1671
+ * The unique identifier for a list of query suggestions for an index.
1672
+ */
1673
+ QuerySuggestionsId?: QuerySuggestionsId;
1674
+ /**
1675
+ * A list of query suggestions for an index.
1676
+ */
1677
+ Suggestions?: SuggestionList;
1678
+ }
1427
1679
  export interface GoogleDriveConfiguration {
1428
1680
  /**
1429
1681
  * The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.
@@ -1669,6 +1921,30 @@ declare namespace Kendra {
1669
1921
  */
1670
1922
  NextToken?: NextToken;
1671
1923
  }
1924
+ export interface ListQuerySuggestionsBlockListsRequest {
1925
+ /**
1926
+ * The identifier of the index for a list of all block lists that exist for that index. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
1927
+ */
1928
+ IndexId: IndexId;
1929
+ /**
1930
+ * If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of block lists (BlockListSummaryItems).
1931
+ */
1932
+ NextToken?: NextToken;
1933
+ /**
1934
+ * The maximum number of block lists to return.
1935
+ */
1936
+ MaxResults?: MaxResultsIntegerForListQuerySuggestionsBlockLists;
1937
+ }
1938
+ export interface ListQuerySuggestionsBlockListsResponse {
1939
+ /**
1940
+ * Summary items for a block list. This includes summary items on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list. For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
1941
+ */
1942
+ BlockListSummaryItems?: QuerySuggestionsBlockListSummaryItems;
1943
+ /**
1944
+ * If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.
1945
+ */
1946
+ NextToken?: NextToken;
1947
+ }
1672
1948
  export interface ListTagsForResourceRequest {
1673
1949
  /**
1674
1950
  * The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for.
@@ -1710,10 +1986,15 @@ declare namespace Kendra {
1710
1986
  export type MaxResultsIntegerForListDataSourcesRequest = number;
1711
1987
  export type MaxResultsIntegerForListFaqsRequest = number;
1712
1988
  export type MaxResultsIntegerForListIndicesRequest = number;
1989
+ export type MaxResultsIntegerForListQuerySuggestionsBlockLists = number;
1713
1990
  export type MaxResultsIntegerForListThesauriRequest = number;
1714
1991
  export type MetricValue = string;
1715
1992
  export type MimeType = string;
1993
+ export type MinimumNumberOfQueryingUsers = number;
1994
+ export type MinimumQueryCount = number;
1995
+ export type Mode = "ENABLED"|"LEARN_ONLY"|string;
1716
1996
  export type NextToken = string;
1997
+ export type ObjectBoolean = boolean;
1717
1998
  export interface OneDriveConfiguration {
1718
1999
  /**
1719
2000
  * The Azure Active Directory domain of the organization.
@@ -1889,6 +2170,38 @@ declare namespace Kendra {
1889
2170
  }
1890
2171
  export type QueryResultItemList = QueryResultItem[];
1891
2172
  export type QueryResultType = "DOCUMENT"|"QUESTION_ANSWER"|"ANSWER"|string;
2173
+ export type QuerySuggestionsBlockListId = string;
2174
+ export type QuerySuggestionsBlockListName = string;
2175
+ export type QuerySuggestionsBlockListStatus = "ACTIVE"|"CREATING"|"DELETING"|"UPDATING"|"ACTIVE_BUT_UPDATE_FAILED"|"FAILED"|string;
2176
+ export interface QuerySuggestionsBlockListSummary {
2177
+ /**
2178
+ * The identifier of a block list.
2179
+ */
2180
+ Id?: QuerySuggestionsBlockListId;
2181
+ /**
2182
+ * The name of the block list.
2183
+ */
2184
+ Name?: QuerySuggestionsBlockListName;
2185
+ /**
2186
+ * The status of the block list.
2187
+ */
2188
+ Status?: QuerySuggestionsBlockListStatus;
2189
+ /**
2190
+ * The date-time summary information for a query suggestions block list was last created.
2191
+ */
2192
+ CreatedAt?: Timestamp;
2193
+ /**
2194
+ * The date-time the block list was last updated.
2195
+ */
2196
+ UpdatedAt?: Timestamp;
2197
+ /**
2198
+ * The number of items in the block list file.
2199
+ */
2200
+ ItemCount?: Integer;
2201
+ }
2202
+ export type QuerySuggestionsBlockListSummaryItems = QuerySuggestionsBlockListSummary[];
2203
+ export type QuerySuggestionsId = string;
2204
+ export type QuerySuggestionsStatus = "ACTIVE"|"UPDATING"|string;
1892
2205
  export type QueryText = string;
1893
2206
  export type ReadAccessType = "ALLOW"|"DENY"|string;
1894
2207
  export interface Relevance {
@@ -1938,11 +2251,11 @@ declare namespace Kendra {
1938
2251
  */
1939
2252
  InclusionPrefixes?: DataSourceInclusionsExclusionsStrings;
1940
2253
  /**
1941
- * A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed. For more information about glob patterns, see glob (programming) in Wikipedia.
2254
+ * A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed. Some examples are: *.txt will include all text files in a directory (files with the extension .txt). ***.txt will include all text files in a directory and its subdirectories. *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.
1942
2255
  */
1943
2256
  InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
1944
2257
  /**
1945
- * A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed. For more information about glob patterns, see glob (programming) in Wikipedia.
2258
+ * A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed. Some examples are: *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg). *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'. ***internal* will exclude all internal-related files in a directory and its subdirectories.
1946
2259
  */
1947
2260
  ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
1948
2261
  DocumentsMetadataConfiguration?: DocumentsMetadataConfiguration;
@@ -1968,7 +2281,7 @@ declare namespace Kendra {
1968
2281
  */
1969
2282
  DocumentDataFieldName: DataSourceFieldName;
1970
2283
  /**
1971
- * The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title collumn.
2284
+ * The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
1972
2285
  */
1973
2286
  DocumentTitleFieldName?: DataSourceFieldName;
1974
2287
  /**
@@ -2331,6 +2644,45 @@ declare namespace Kendra {
2331
2644
  }
2332
2645
  export type SubnetId = string;
2333
2646
  export type SubnetIdList = SubnetId[];
2647
+ export interface Suggestion {
2648
+ /**
2649
+ * The unique UUID (universally unique identifier) of a single query suggestion.
2650
+ */
2651
+ Id?: ResultId;
2652
+ /**
2653
+ * The value for the unique UUID (universally unique identifier) of a single query suggestion. The value is the text string of a suggestion.
2654
+ */
2655
+ Value?: SuggestionValue;
2656
+ }
2657
+ export interface SuggestionHighlight {
2658
+ /**
2659
+ * The zero-based location in the response string where the highlight starts.
2660
+ */
2661
+ BeginOffset?: Integer;
2662
+ /**
2663
+ * The zero-based location in the response string where the highlight ends.
2664
+ */
2665
+ EndOffset?: Integer;
2666
+ }
2667
+ export type SuggestionHighlightList = SuggestionHighlight[];
2668
+ export type SuggestionList = Suggestion[];
2669
+ export type SuggestionQueryText = string;
2670
+ export interface SuggestionTextWithHighlights {
2671
+ /**
2672
+ * The query suggestion text to display to the user.
2673
+ */
2674
+ Text?: String;
2675
+ /**
2676
+ * The beginning and end of the query suggestion text that should be highlighted.
2677
+ */
2678
+ Highlights?: SuggestionHighlightList;
2679
+ }
2680
+ export interface SuggestionValue {
2681
+ /**
2682
+ * The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.
2683
+ */
2684
+ Text?: SuggestionTextWithHighlights;
2685
+ }
2334
2686
  export type TableName = string;
2335
2687
  export interface Tag {
2336
2688
  /**
@@ -2491,6 +2843,58 @@ declare namespace Kendra {
2491
2843
  */
2492
2844
  UserContextPolicy?: UserContextPolicy;
2493
2845
  }
2846
+ export interface UpdateQuerySuggestionsBlockListRequest {
2847
+ /**
2848
+ * The identifier of the index for a block list.
2849
+ */
2850
+ IndexId: IndexId;
2851
+ /**
2852
+ * The unique identifier of a block list.
2853
+ */
2854
+ Id: QuerySuggestionsBlockListId;
2855
+ /**
2856
+ * The name of a block list.
2857
+ */
2858
+ Name?: QuerySuggestionsBlockListName;
2859
+ /**
2860
+ * The description for a block list.
2861
+ */
2862
+ Description?: Description;
2863
+ /**
2864
+ * The S3 path where your block list text file sits in S3. If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list. If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.
2865
+ */
2866
+ SourceS3Path?: S3Path;
2867
+ /**
2868
+ * The IAM (Identity and Access Management) role used to access the block list text file in S3.
2869
+ */
2870
+ RoleArn?: RoleArn;
2871
+ }
2872
+ export interface UpdateQuerySuggestionsConfigRequest {
2873
+ /**
2874
+ * The identifier of the index you want to update query suggestions settings for.
2875
+ */
2876
+ IndexId: IndexId;
2877
+ /**
2878
+ * Set the mode to ENABLED or LEARN_ONLY. By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time. In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.
2879
+ */
2880
+ Mode?: Mode;
2881
+ /**
2882
+ * How recent your queries are in your query log time window. The time window is the number of days from current day to past days. By default, Amazon Kendra sets this to 180.
2883
+ */
2884
+ QueryLogLookBackWindowInDays?: Integer;
2885
+ /**
2886
+ * TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information. If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information. If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions. If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
2887
+ */
2888
+ IncludeQueriesWithoutUserInformation?: ObjectBoolean;
2889
+ /**
2890
+ * The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users. Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users. How you tune this setting depends on your specific needs.
2891
+ */
2892
+ MinimumNumberOfQueryingUsers?: MinimumNumberOfQueryingUsers;
2893
+ /**
2894
+ * The the minimum number of times a query must be searched in order to be eligible to suggest to your users. Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users. How you tune this setting depends on your specific needs.
2895
+ */
2896
+ MinimumQueryCount?: MinimumQueryCount;
2897
+ }
2494
2898
  export interface UpdateThesaurusRequest {
2495
2899
  /**
2496
2900
  * The identifier of the thesaurus to update.
@@ -2367,7 +2367,7 @@ declare namespace Lightsail {
2367
2367
  }
2368
2368
  export interface CreateDomainRequest {
2369
2369
  /**
2370
- * The domain name to manage (e.g., example.com). You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.
2370
+ * The domain name to manage (e.g., example.com). You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain using Lightsail.
2371
2371
  */
2372
2372
  domainName: DomainName;
2373
2373
  /**
@@ -3296,7 +3296,7 @@ declare namespace Lightsail {
3296
3296
  */
3297
3297
  name?: DomainName;
3298
3298
  /**
3299
- * The target AWS name server (e.g., ns-111.awsdns-22.com.). For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure to also set isAlias to true when setting up an A record for a load balancer.
3299
+ * The target IP address (e.g., 192.0.2.0), or AWS name server (e.g., ns-111.awsdns-22.com.). For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.
3300
3300
  */
3301
3301
  target?: string;
3302
3302
  /**
@@ -3304,7 +3304,7 @@ declare namespace Lightsail {
3304
3304
  */
3305
3305
  isAlias?: boolean;
3306
3306
  /**
3307
- * The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The following domain entry types can be used: A CNAME MX NS SOA SRV TXT
3307
+ * The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The following domain entry types can be used: A AAAA CNAME MX NS SOA SRV TXT
3308
3308
  */
3309
3309
  type?: DomainEntryType;
3310
3310
  /**