aws-sdk 2.927.0 → 2.931.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 +27 -1
- package/README.md +1 -1
- package/apis/chime-2018-05-01.min.json +48 -4
- package/apis/connect-2017-08-08.min.json +229 -124
- package/apis/connect-2017-08-08.paginators.json +6 -0
- package/apis/ec2-2016-11-15.min.json +1034 -898
- package/apis/greengrassv2-2020-11-30.min.json +166 -28
- package/apis/greengrassv2-2020-11-30.paginators.json +6 -0
- package/apis/iotanalytics-2017-11-27.min.json +68 -27
- package/apis/kendra-2019-02-03.min.json +128 -35
- package/apis/kms-2014-11-01.examples.json +8 -3
- package/apis/kms-2014-11-01.min.json +101 -20
- package/apis/mediatailor-2018-04-23.min.json +67 -59
- package/apis/metadata.json +2 -1
- package/apis/models.lex.v2-2020-08-07.min.json +60 -37
- package/apis/rds-2014-10-31.min.json +41 -20
- package/apis/redshift-data-2019-12-20.min.json +26 -3
- package/apis/runtime.lex.v2-2020-08-07.min.json +49 -35
- package/clients/browser_default.d.ts +1 -0
- package/clients/browser_default.js +1 -0
- package/clients/chime.d.ts +32 -6
- package/clients/connect.d.ts +184 -94
- package/clients/ec2.d.ts +192 -41
- package/clients/greengrassv2.d.ts +138 -2
- package/clients/iotanalytics.d.ts +51 -4
- package/clients/kendra.d.ts +114 -3
- package/clients/kms.d.ts +260 -136
- package/clients/lexmodelsv2.d.ts +30 -4
- package/clients/lexruntimev2.d.ts +46 -36
- package/clients/lookoutmetrics.d.ts +4 -4
- package/clients/mediatailor.d.ts +19 -1
- package/clients/rds.d.ts +248 -207
- package/clients/redshiftdata.d.ts +25 -0
- package/clients/sagemaker.d.ts +6 -6
- package/dist/aws-sdk-core-react-native.js +26 -2
- package/dist/aws-sdk-react-native.js +59 -39
- package/dist/aws-sdk.js +4438 -1559
- package/dist/aws-sdk.min.js +69 -68
- package/lib/core.js +1 -1
- package/lib/event_listeners.js +23 -0
- package/lib/model/operation.js +1 -0
- package/lib/services/s3.js +18 -22
- package/package.json +1 -1
- package/scripts/region-checker/allowlist.js +7 -7
|
@@ -11,6 +11,22 @@ declare class GreengrassV2 extends Service {
|
|
|
11
11
|
*/
|
|
12
12
|
constructor(options?: GreengrassV2.Types.ClientConfiguration)
|
|
13
13
|
config: Config & GreengrassV2.Types.ClientConfiguration;
|
|
14
|
+
/**
|
|
15
|
+
* Associate a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to AWS IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the AWS IoT Greengrass V2 Developer Guide. Client devices are local IoT devices that connect to and communicate with an AWS IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to AWS IoT Core and interact with client devices in AWS IoT Greengrass components. For more information, see Interact with local IoT devices in the AWS IoT Greengrass V2 Developer Guide.
|
|
16
|
+
*/
|
|
17
|
+
batchAssociateClientDeviceWithCoreDevice(params: GreengrassV2.Types.BatchAssociateClientDeviceWithCoreDeviceRequest, callback?: (err: AWSError, data: GreengrassV2.Types.BatchAssociateClientDeviceWithCoreDeviceResponse) => void): Request<GreengrassV2.Types.BatchAssociateClientDeviceWithCoreDeviceResponse, AWSError>;
|
|
18
|
+
/**
|
|
19
|
+
* Associate a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to AWS IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the AWS IoT Greengrass V2 Developer Guide. Client devices are local IoT devices that connect to and communicate with an AWS IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to AWS IoT Core and interact with client devices in AWS IoT Greengrass components. For more information, see Interact with local IoT devices in the AWS IoT Greengrass V2 Developer Guide.
|
|
20
|
+
*/
|
|
21
|
+
batchAssociateClientDeviceWithCoreDevice(callback?: (err: AWSError, data: GreengrassV2.Types.BatchAssociateClientDeviceWithCoreDeviceResponse) => void): Request<GreengrassV2.Types.BatchAssociateClientDeviceWithCoreDeviceResponse, AWSError>;
|
|
22
|
+
/**
|
|
23
|
+
* Disassociate a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.
|
|
24
|
+
*/
|
|
25
|
+
batchDisassociateClientDeviceFromCoreDevice(params: GreengrassV2.Types.BatchDisassociateClientDeviceFromCoreDeviceRequest, callback?: (err: AWSError, data: GreengrassV2.Types.BatchDisassociateClientDeviceFromCoreDeviceResponse) => void): Request<GreengrassV2.Types.BatchDisassociateClientDeviceFromCoreDeviceResponse, AWSError>;
|
|
26
|
+
/**
|
|
27
|
+
* Disassociate a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.
|
|
28
|
+
*/
|
|
29
|
+
batchDisassociateClientDeviceFromCoreDevice(callback?: (err: AWSError, data: GreengrassV2.Types.BatchDisassociateClientDeviceFromCoreDeviceResponse) => void): Request<GreengrassV2.Types.BatchDisassociateClientDeviceFromCoreDeviceResponse, AWSError>;
|
|
14
30
|
/**
|
|
15
31
|
* Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.
|
|
16
32
|
*/
|
|
@@ -92,11 +108,19 @@ declare class GreengrassV2 extends Service {
|
|
|
92
108
|
*/
|
|
93
109
|
getDeployment(callback?: (err: AWSError, data: GreengrassV2.Types.GetDeploymentResponse) => void): Request<GreengrassV2.Types.GetDeploymentResponse, AWSError>;
|
|
94
110
|
/**
|
|
95
|
-
* Retrieves a paginated list of
|
|
111
|
+
* Retrieves a paginated list of client devices that are associated with a core device.
|
|
112
|
+
*/
|
|
113
|
+
listClientDevicesAssociatedWithCoreDevice(params: GreengrassV2.Types.ListClientDevicesAssociatedWithCoreDeviceRequest, callback?: (err: AWSError, data: GreengrassV2.Types.ListClientDevicesAssociatedWithCoreDeviceResponse) => void): Request<GreengrassV2.Types.ListClientDevicesAssociatedWithCoreDeviceResponse, AWSError>;
|
|
114
|
+
/**
|
|
115
|
+
* Retrieves a paginated list of client devices that are associated with a core device.
|
|
116
|
+
*/
|
|
117
|
+
listClientDevicesAssociatedWithCoreDevice(callback?: (err: AWSError, data: GreengrassV2.Types.ListClientDevicesAssociatedWithCoreDeviceResponse) => void): Request<GreengrassV2.Types.ListClientDevicesAssociatedWithCoreDeviceResponse, AWSError>;
|
|
118
|
+
/**
|
|
119
|
+
* Retrieves a paginated list of all versions for a component. Greater versions are listed first.
|
|
96
120
|
*/
|
|
97
121
|
listComponentVersions(params: GreengrassV2.Types.ListComponentVersionsRequest, callback?: (err: AWSError, data: GreengrassV2.Types.ListComponentVersionsResponse) => void): Request<GreengrassV2.Types.ListComponentVersionsResponse, AWSError>;
|
|
98
122
|
/**
|
|
99
|
-
* Retrieves a paginated list of all versions for a component.
|
|
123
|
+
* Retrieves a paginated list of all versions for a component. Greater versions are listed first.
|
|
100
124
|
*/
|
|
101
125
|
listComponentVersions(callback?: (err: AWSError, data: GreengrassV2.Types.ListComponentVersionsResponse) => void): Request<GreengrassV2.Types.ListComponentVersionsResponse, AWSError>;
|
|
102
126
|
/**
|
|
@@ -173,6 +197,71 @@ declare class GreengrassV2 extends Service {
|
|
|
173
197
|
untagResource(callback?: (err: AWSError, data: GreengrassV2.Types.UntagResourceResponse) => void): Request<GreengrassV2.Types.UntagResourceResponse, AWSError>;
|
|
174
198
|
}
|
|
175
199
|
declare namespace GreengrassV2 {
|
|
200
|
+
export interface AssociateClientDeviceWithCoreDeviceEntry {
|
|
201
|
+
/**
|
|
202
|
+
* The name of the AWS IoT thing that represents the client device to associate.
|
|
203
|
+
*/
|
|
204
|
+
thingName: IoTThingName;
|
|
205
|
+
}
|
|
206
|
+
export type AssociateClientDeviceWithCoreDeviceEntryList = AssociateClientDeviceWithCoreDeviceEntry[];
|
|
207
|
+
export interface AssociateClientDeviceWithCoreDeviceErrorEntry {
|
|
208
|
+
/**
|
|
209
|
+
* The name of the AWS IoT thing whose associate request failed.
|
|
210
|
+
*/
|
|
211
|
+
thingName?: IoTThingName;
|
|
212
|
+
/**
|
|
213
|
+
* The error code for the request.
|
|
214
|
+
*/
|
|
215
|
+
code?: NonEmptyString;
|
|
216
|
+
/**
|
|
217
|
+
* A message that provides additional information about the error.
|
|
218
|
+
*/
|
|
219
|
+
message?: NonEmptyString;
|
|
220
|
+
}
|
|
221
|
+
export type AssociateClientDeviceWithCoreDeviceErrorList = AssociateClientDeviceWithCoreDeviceErrorEntry[];
|
|
222
|
+
export interface AssociatedClientDevice {
|
|
223
|
+
/**
|
|
224
|
+
* The name of the AWS IoT thing that represents the associated client device.
|
|
225
|
+
*/
|
|
226
|
+
thingName?: IoTThingName;
|
|
227
|
+
/**
|
|
228
|
+
* The time that the client device was associated, expressed in ISO 8601 format.
|
|
229
|
+
*/
|
|
230
|
+
associationTimestamp?: Timestamp;
|
|
231
|
+
}
|
|
232
|
+
export type AssociatedClientDeviceList = AssociatedClientDevice[];
|
|
233
|
+
export interface BatchAssociateClientDeviceWithCoreDeviceRequest {
|
|
234
|
+
/**
|
|
235
|
+
* The list of client devices to associate.
|
|
236
|
+
*/
|
|
237
|
+
entries?: AssociateClientDeviceWithCoreDeviceEntryList;
|
|
238
|
+
/**
|
|
239
|
+
* The name of the core device. This is also the name of the AWS IoT thing.
|
|
240
|
+
*/
|
|
241
|
+
coreDeviceThingName: IoTThingName;
|
|
242
|
+
}
|
|
243
|
+
export interface BatchAssociateClientDeviceWithCoreDeviceResponse {
|
|
244
|
+
/**
|
|
245
|
+
* The list of any errors for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to associate.
|
|
246
|
+
*/
|
|
247
|
+
errorEntries?: AssociateClientDeviceWithCoreDeviceErrorList;
|
|
248
|
+
}
|
|
249
|
+
export interface BatchDisassociateClientDeviceFromCoreDeviceRequest {
|
|
250
|
+
/**
|
|
251
|
+
* The list of client devices to disassociate.
|
|
252
|
+
*/
|
|
253
|
+
entries?: DisassociateClientDeviceFromCoreDeviceEntryList;
|
|
254
|
+
/**
|
|
255
|
+
* The name of the core device. This is also the name of the AWS IoT thing.
|
|
256
|
+
*/
|
|
257
|
+
coreDeviceThingName: IoTThingName;
|
|
258
|
+
}
|
|
259
|
+
export interface BatchDisassociateClientDeviceFromCoreDeviceResponse {
|
|
260
|
+
/**
|
|
261
|
+
* The list of errors (if any) for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to disassociate.
|
|
262
|
+
*/
|
|
263
|
+
errorEntries?: DisassociateClientDeviceFromCoreDeviceErrorList;
|
|
264
|
+
}
|
|
176
265
|
export interface CancelDeploymentRequest {
|
|
177
266
|
/**
|
|
178
267
|
* The ID of the deployment.
|
|
@@ -569,6 +658,28 @@ declare namespace GreengrassV2 {
|
|
|
569
658
|
}
|
|
570
659
|
export type Description = string;
|
|
571
660
|
export type DescriptionString = string;
|
|
661
|
+
export interface DisassociateClientDeviceFromCoreDeviceEntry {
|
|
662
|
+
/**
|
|
663
|
+
* The name of the AWS IoT thing that represents the client device to disassociate.
|
|
664
|
+
*/
|
|
665
|
+
thingName: IoTThingName;
|
|
666
|
+
}
|
|
667
|
+
export type DisassociateClientDeviceFromCoreDeviceEntryList = DisassociateClientDeviceFromCoreDeviceEntry[];
|
|
668
|
+
export interface DisassociateClientDeviceFromCoreDeviceErrorEntry {
|
|
669
|
+
/**
|
|
670
|
+
* The name of the AWS IoT thing whose disassociate request failed.
|
|
671
|
+
*/
|
|
672
|
+
thingName?: IoTThingName;
|
|
673
|
+
/**
|
|
674
|
+
* The error code for the request.
|
|
675
|
+
*/
|
|
676
|
+
code?: NonEmptyString;
|
|
677
|
+
/**
|
|
678
|
+
* A message that provides additional information about the error.
|
|
679
|
+
*/
|
|
680
|
+
message?: NonEmptyString;
|
|
681
|
+
}
|
|
682
|
+
export type DisassociateClientDeviceFromCoreDeviceErrorList = DisassociateClientDeviceFromCoreDeviceErrorEntry[];
|
|
572
683
|
export interface EffectiveDeployment {
|
|
573
684
|
/**
|
|
574
685
|
* The ID of the deployment.
|
|
@@ -852,6 +963,7 @@ declare namespace GreengrassV2 {
|
|
|
852
963
|
*/
|
|
853
964
|
inProgressTimeoutInMinutes?: IoTJobInProgressTimeoutInMinutes;
|
|
854
965
|
}
|
|
966
|
+
export type IoTThingName = string;
|
|
855
967
|
export type IsLatestForTarget = boolean;
|
|
856
968
|
export type IsRoot = boolean;
|
|
857
969
|
export interface LambdaContainerParams {
|
|
@@ -1008,6 +1120,30 @@ declare namespace GreengrassV2 {
|
|
|
1008
1120
|
addGroupOwner?: OptionalBoolean;
|
|
1009
1121
|
}
|
|
1010
1122
|
export type LifecycleStateDetails = string;
|
|
1123
|
+
export interface ListClientDevicesAssociatedWithCoreDeviceRequest {
|
|
1124
|
+
/**
|
|
1125
|
+
* The name of the core device. This is also the name of the AWS IoT thing.
|
|
1126
|
+
*/
|
|
1127
|
+
coreDeviceThingName: IoTThingName;
|
|
1128
|
+
/**
|
|
1129
|
+
* The maximum number of results to be returned per paginated request.
|
|
1130
|
+
*/
|
|
1131
|
+
maxResults?: DefaultMaxResults;
|
|
1132
|
+
/**
|
|
1133
|
+
* The token to be used for the next set of paginated results.
|
|
1134
|
+
*/
|
|
1135
|
+
nextToken?: NextTokenString;
|
|
1136
|
+
}
|
|
1137
|
+
export interface ListClientDevicesAssociatedWithCoreDeviceResponse {
|
|
1138
|
+
/**
|
|
1139
|
+
* A list that describes the client devices that are associated with the core device.
|
|
1140
|
+
*/
|
|
1141
|
+
associatedClientDevices?: AssociatedClientDeviceList;
|
|
1142
|
+
/**
|
|
1143
|
+
* The token for the next set of results, or null if there are no additional results.
|
|
1144
|
+
*/
|
|
1145
|
+
nextToken?: NextTokenString;
|
|
1146
|
+
}
|
|
1011
1147
|
export interface ListComponentVersionsRequest {
|
|
1012
1148
|
/**
|
|
1013
1149
|
* The ARN of the component version.
|
|
@@ -52,11 +52,11 @@ declare class IoTAnalytics extends Service {
|
|
|
52
52
|
*/
|
|
53
53
|
createDatasetContent(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetContentResponse) => void): Request<IoTAnalytics.Types.CreateDatasetContentResponse, AWSError>;
|
|
54
54
|
/**
|
|
55
|
-
* Creates a data store, which is a repository for messages.
|
|
55
|
+
* Creates a data store, which is a repository for messages. Only data stores that are used to save pipeline data can be configured with ParquetConfiguration.
|
|
56
56
|
*/
|
|
57
57
|
createDatastore(params: IoTAnalytics.Types.CreateDatastoreRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatastoreResponse) => void): Request<IoTAnalytics.Types.CreateDatastoreResponse, AWSError>;
|
|
58
58
|
/**
|
|
59
|
-
* Creates a data store, which is a repository for messages.
|
|
59
|
+
* Creates a data store, which is a repository for messages. Only data stores that are used to save pipeline data can be configured with ParquetConfiguration.
|
|
60
60
|
*/
|
|
61
61
|
createDatastore(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatastoreResponse) => void): Request<IoTAnalytics.Types.CreateDatastoreResponse, AWSError>;
|
|
62
62
|
/**
|
|
@@ -400,7 +400,7 @@ declare namespace IoTAnalytics {
|
|
|
400
400
|
export type ChannelArn = string;
|
|
401
401
|
export interface ChannelMessages {
|
|
402
402
|
/**
|
|
403
|
-
* Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your channel messages.
|
|
403
|
+
* Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your channel messages. You must use the full path for the key. Example path: channel/mychannel/__dt=2020-02-29 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz
|
|
404
404
|
*/
|
|
405
405
|
s3Paths?: S3PathChannelMessages;
|
|
406
406
|
}
|
|
@@ -608,6 +608,10 @@ declare namespace IoTAnalytics {
|
|
|
608
608
|
* Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet. The default file format is JSON. You can specify only one format. You can't change the file format after you create the data store.
|
|
609
609
|
*/
|
|
610
610
|
fileFormatConfiguration?: FileFormatConfiguration;
|
|
611
|
+
/**
|
|
612
|
+
* Contains information about the partitions in a data store.
|
|
613
|
+
*/
|
|
614
|
+
datastorePartitions?: DatastorePartitions;
|
|
611
615
|
}
|
|
612
616
|
export interface CreateDatastoreResponse {
|
|
613
617
|
/**
|
|
@@ -928,6 +932,10 @@ declare namespace IoTAnalytics {
|
|
|
928
932
|
* Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet. The default file format is JSON. You can specify only one format. You can't change the file format after you create the data store.
|
|
929
933
|
*/
|
|
930
934
|
fileFormatConfiguration?: FileFormatConfiguration;
|
|
935
|
+
/**
|
|
936
|
+
* Contains information about the partitions in a data store.
|
|
937
|
+
*/
|
|
938
|
+
datastorePartitions?: DatastorePartitions;
|
|
931
939
|
}
|
|
932
940
|
export interface DatastoreActivity {
|
|
933
941
|
/**
|
|
@@ -941,6 +949,22 @@ declare namespace IoTAnalytics {
|
|
|
941
949
|
}
|
|
942
950
|
export type DatastoreArn = string;
|
|
943
951
|
export type DatastoreName = string;
|
|
952
|
+
export interface DatastorePartition {
|
|
953
|
+
/**
|
|
954
|
+
* A partition defined by an attributeName.
|
|
955
|
+
*/
|
|
956
|
+
attributePartition?: Partition;
|
|
957
|
+
/**
|
|
958
|
+
* A partition defined by an attributeName and a timestamp format.
|
|
959
|
+
*/
|
|
960
|
+
timestampPartition?: TimestampPartition;
|
|
961
|
+
}
|
|
962
|
+
export interface DatastorePartitions {
|
|
963
|
+
/**
|
|
964
|
+
* A list of partitions in a data store.
|
|
965
|
+
*/
|
|
966
|
+
partitions?: Partitions;
|
|
967
|
+
}
|
|
944
968
|
export interface DatastoreStatistics {
|
|
945
969
|
/**
|
|
946
970
|
* The estimated size of the data store.
|
|
@@ -998,6 +1022,10 @@ declare namespace IoTAnalytics {
|
|
|
998
1022
|
* The file format of the data in the data store.
|
|
999
1023
|
*/
|
|
1000
1024
|
fileFormatType?: FileFormatType;
|
|
1025
|
+
/**
|
|
1026
|
+
* Contains information about the partitions in a data store.
|
|
1027
|
+
*/
|
|
1028
|
+
datastorePartitions?: DatastorePartitions;
|
|
1001
1029
|
}
|
|
1002
1030
|
export interface DeleteChannelRequest {
|
|
1003
1031
|
/**
|
|
@@ -1486,6 +1514,14 @@ declare namespace IoTAnalytics {
|
|
|
1486
1514
|
*/
|
|
1487
1515
|
schemaDefinition?: SchemaDefinition;
|
|
1488
1516
|
}
|
|
1517
|
+
export interface Partition {
|
|
1518
|
+
/**
|
|
1519
|
+
* The attribute name of the partition.
|
|
1520
|
+
*/
|
|
1521
|
+
attributeName: PartitionAttributeName;
|
|
1522
|
+
}
|
|
1523
|
+
export type PartitionAttributeName = string;
|
|
1524
|
+
export type Partitions = DatastorePartition[];
|
|
1489
1525
|
export interface Pipeline {
|
|
1490
1526
|
/**
|
|
1491
1527
|
* The name of the pipeline.
|
|
@@ -1719,7 +1755,7 @@ declare namespace IoTAnalytics {
|
|
|
1719
1755
|
export type ScheduleExpression = string;
|
|
1720
1756
|
export interface SchemaDefinition {
|
|
1721
1757
|
/**
|
|
1722
|
-
* Specifies one or more columns that store your data. Each schema can have up to 100 columns. Each column can have up to 100 nested types
|
|
1758
|
+
* Specifies one or more columns that store your data. Each schema can have up to 100 columns. Each column can have up to 100 nested types.
|
|
1723
1759
|
*/
|
|
1724
1760
|
columns?: Columns;
|
|
1725
1761
|
}
|
|
@@ -1812,6 +1848,17 @@ declare namespace IoTAnalytics {
|
|
|
1812
1848
|
export type TagValue = string;
|
|
1813
1849
|
export type TimeExpression = string;
|
|
1814
1850
|
export type Timestamp = Date;
|
|
1851
|
+
export type TimestampFormat = string;
|
|
1852
|
+
export interface TimestampPartition {
|
|
1853
|
+
/**
|
|
1854
|
+
* The attribute name of the partition defined by a timestamp.
|
|
1855
|
+
*/
|
|
1856
|
+
attributeName: PartitionAttributeName;
|
|
1857
|
+
/**
|
|
1858
|
+
* The timestamp format of a partition defined by a timestamp.
|
|
1859
|
+
*/
|
|
1860
|
+
timestampFormat?: TimestampFormat;
|
|
1861
|
+
}
|
|
1815
1862
|
export interface TriggeringDataset {
|
|
1816
1863
|
/**
|
|
1817
1864
|
* The name of the dataset whose content generation triggers the new dataset content generation.
|
package/clients/kendra.d.ts
CHANGED
|
@@ -403,6 +403,27 @@ declare namespace Kendra {
|
|
|
403
403
|
LessThanOrEquals?: DocumentAttribute;
|
|
404
404
|
}
|
|
405
405
|
export type AttributeFilterList = AttributeFilter[];
|
|
406
|
+
export interface AuthenticationConfiguration {
|
|
407
|
+
/**
|
|
408
|
+
* The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials. The list includes the name and port number of the website host.
|
|
409
|
+
*/
|
|
410
|
+
BasicAuthentication?: BasicAuthenticationConfigurationList;
|
|
411
|
+
}
|
|
412
|
+
export interface BasicAuthenticationConfiguration {
|
|
413
|
+
/**
|
|
414
|
+
* The name of the website host you want to connect to using authentication credentials. For example, the host name of https://a.example.com/page1.html is "a.example.com".
|
|
415
|
+
*/
|
|
416
|
+
Host: Host;
|
|
417
|
+
/**
|
|
418
|
+
* The port number of the website host you want to connect to using authentication credentials. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
|
|
419
|
+
*/
|
|
420
|
+
Port: Port;
|
|
421
|
+
/**
|
|
422
|
+
* Your secret ARN, which you can create in AWS Secrets Manager You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.
|
|
423
|
+
*/
|
|
424
|
+
Credentials: SecretArn;
|
|
425
|
+
}
|
|
426
|
+
export type BasicAuthenticationConfigurationList = BasicAuthenticationConfiguration[];
|
|
406
427
|
export interface BatchDeleteDocumentRequest {
|
|
407
428
|
/**
|
|
408
429
|
* The identifier of the index that contains the documents to delete.
|
|
@@ -509,11 +530,11 @@ declare namespace Kendra {
|
|
|
509
530
|
export type Boolean = boolean;
|
|
510
531
|
export interface CapacityUnitsConfiguration {
|
|
511
532
|
/**
|
|
512
|
-
* The amount of extra storage capacity for an index.
|
|
533
|
+
* The amount of extra storage capacity for an index. A single capacity unit for an index provides 150 GB of storage space or 500,000 documents, whichever is reached first.
|
|
513
534
|
*/
|
|
514
535
|
StorageCapacityUnits: StorageCapacityUnit;
|
|
515
536
|
/**
|
|
516
|
-
* The amount of extra query capacity for an index.
|
|
537
|
+
* The amount of extra query capacity for an index and GetQuerySuggestions capacity. A single extra capacity unit for an index provides 0.5 queries per second or approximately 40,000 queries per day. GetQuerySuggestions capacity is 5 times the provisioned query capacity for an index. For example, the base capacity for an index is 0.5 queries per second, so GetQuerySuggestions capacity is 2.5 calls per second. If adding another 0.5 queries per second to total 1 queries per second for an index, the GetQuerySuggestions capacity is 5 calls per second.
|
|
517
538
|
*/
|
|
518
539
|
QueryCapacityUnits: QueryCapacityUnit;
|
|
519
540
|
}
|
|
@@ -736,6 +757,7 @@ declare namespace Kendra {
|
|
|
736
757
|
SecretArn: SecretArn;
|
|
737
758
|
}
|
|
738
759
|
export type ContentType = "PDF"|"HTML"|"MS_WORD"|"PLAIN_TEXT"|"PPT"|string;
|
|
760
|
+
export type CrawlDepth = number;
|
|
739
761
|
export interface CreateDataSourceRequest {
|
|
740
762
|
/**
|
|
741
763
|
* A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.
|
|
@@ -969,6 +991,7 @@ declare namespace Kendra {
|
|
|
969
991
|
* Provides configuration for data sources that connect to Google Drive.
|
|
970
992
|
*/
|
|
971
993
|
GoogleDriveConfiguration?: GoogleDriveConfiguration;
|
|
994
|
+
WebCrawlerConfiguration?: WebCrawlerConfiguration;
|
|
972
995
|
}
|
|
973
996
|
export type DataSourceDateFieldFormat = string;
|
|
974
997
|
export type DataSourceFieldName = string;
|
|
@@ -1088,7 +1111,7 @@ declare namespace Kendra {
|
|
|
1088
1111
|
IndexFieldName: IndexFieldName;
|
|
1089
1112
|
}
|
|
1090
1113
|
export type DataSourceToIndexFieldMappingList = DataSourceToIndexFieldMapping[];
|
|
1091
|
-
export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|string;
|
|
1114
|
+
export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|string;
|
|
1092
1115
|
export interface DataSourceVpcConfiguration {
|
|
1093
1116
|
/**
|
|
1094
1117
|
* A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
|
|
@@ -1783,6 +1806,7 @@ declare namespace Kendra {
|
|
|
1783
1806
|
}
|
|
1784
1807
|
export type HighlightList = Highlight[];
|
|
1785
1808
|
export type HighlightType = "STANDARD"|"THESAURUS_SYNONYM"|string;
|
|
1809
|
+
export type Host = string;
|
|
1786
1810
|
export type Importance = number;
|
|
1787
1811
|
export interface IndexConfigurationSummary {
|
|
1788
1812
|
/**
|
|
@@ -2038,12 +2062,15 @@ declare namespace Kendra {
|
|
|
2038
2062
|
ThesaurusSummaryItems?: ThesaurusSummaryItems;
|
|
2039
2063
|
}
|
|
2040
2064
|
export type Long = number;
|
|
2065
|
+
export type MaxContentSizePerPageInMegaBytes = number;
|
|
2066
|
+
export type MaxLinksPerPage = number;
|
|
2041
2067
|
export type MaxResultsIntegerForListDataSourceSyncJobsRequest = number;
|
|
2042
2068
|
export type MaxResultsIntegerForListDataSourcesRequest = number;
|
|
2043
2069
|
export type MaxResultsIntegerForListFaqsRequest = number;
|
|
2044
2070
|
export type MaxResultsIntegerForListIndicesRequest = number;
|
|
2045
2071
|
export type MaxResultsIntegerForListQuerySuggestionsBlockLists = number;
|
|
2046
2072
|
export type MaxResultsIntegerForListThesauriRequest = number;
|
|
2073
|
+
export type MaxUrlsPerMinuteCrawlRate = number;
|
|
2047
2074
|
export type MetricValue = string;
|
|
2048
2075
|
export type MimeType = string;
|
|
2049
2076
|
export type MinimumNumberOfQueryingUsers = number;
|
|
@@ -2094,6 +2121,7 @@ declare namespace Kendra {
|
|
|
2094
2121
|
OneDriveUserS3Path?: S3Path;
|
|
2095
2122
|
}
|
|
2096
2123
|
export type Order = "ASCENDING"|"DESCENDING"|string;
|
|
2124
|
+
export type Port = number;
|
|
2097
2125
|
export interface Principal {
|
|
2098
2126
|
/**
|
|
2099
2127
|
* The name of the user or group.
|
|
@@ -2111,6 +2139,20 @@ declare namespace Kendra {
|
|
|
2111
2139
|
export type PrincipalList = Principal[];
|
|
2112
2140
|
export type PrincipalName = string;
|
|
2113
2141
|
export type PrincipalType = "USER"|"GROUP"|string;
|
|
2142
|
+
export interface ProxyConfiguration {
|
|
2143
|
+
/**
|
|
2144
|
+
* The name of the website host you want to connect to via a web proxy server. For example, the host name of https://a.example.com/page1.html is "a.example.com".
|
|
2145
|
+
*/
|
|
2146
|
+
Host: Host;
|
|
2147
|
+
/**
|
|
2148
|
+
* The port number of the website host you want to connect to via a web proxy server. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
|
|
2149
|
+
*/
|
|
2150
|
+
Port: Port;
|
|
2151
|
+
/**
|
|
2152
|
+
* Your secret ARN, which you can create in AWS Secrets Manager The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
|
|
2153
|
+
*/
|
|
2154
|
+
Credentials?: SecretArn;
|
|
2155
|
+
}
|
|
2114
2156
|
export type QueryCapacityUnit = number;
|
|
2115
2157
|
export type QueryId = string;
|
|
2116
2158
|
export type QueryIdentifiersEnclosingOption = "DOUBLE_QUOTES"|"NONE"|string;
|
|
@@ -2497,6 +2539,18 @@ declare namespace Kendra {
|
|
|
2497
2539
|
}
|
|
2498
2540
|
export type SecretArn = string;
|
|
2499
2541
|
export type SecurityGroupIdList = VpcSecurityGroupId[];
|
|
2542
|
+
export type SeedUrl = string;
|
|
2543
|
+
export interface SeedUrlConfiguration {
|
|
2544
|
+
/**
|
|
2545
|
+
* The list of seed or starting point URLs of the websites you want to crawl. The list can include a maximum of 100 seed URLs.
|
|
2546
|
+
*/
|
|
2547
|
+
SeedUrls: SeedUrlList;
|
|
2548
|
+
/**
|
|
2549
|
+
* 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 webpages link to. The default mode is set to HOST_ONLY.
|
|
2550
|
+
*/
|
|
2551
|
+
WebCrawlerMode?: WebCrawlerMode;
|
|
2552
|
+
}
|
|
2553
|
+
export type SeedUrlList = SeedUrl[];
|
|
2500
2554
|
export interface ServerSideEncryptionConfiguration {
|
|
2501
2555
|
/**
|
|
2502
2556
|
* The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
|
|
@@ -2635,6 +2689,14 @@ declare namespace Kendra {
|
|
|
2635
2689
|
export type SharePointUrlList = Url[];
|
|
2636
2690
|
export type SharePointVersion = "SHAREPOINT_ONLINE"|string;
|
|
2637
2691
|
export type SharedDriveId = string;
|
|
2692
|
+
export type SiteMap = string;
|
|
2693
|
+
export interface SiteMapsConfiguration {
|
|
2694
|
+
/**
|
|
2695
|
+
* The list of sitemap URLs of the websites you want to crawl. The list can include a maximum of three sitemap URLs.
|
|
2696
|
+
*/
|
|
2697
|
+
SiteMaps: SiteMapsList;
|
|
2698
|
+
}
|
|
2699
|
+
export type SiteMapsList = SiteMap[];
|
|
2638
2700
|
export type SortOrder = "DESC"|"ASC"|string;
|
|
2639
2701
|
export interface SortingConfiguration {
|
|
2640
2702
|
/**
|
|
@@ -2993,6 +3055,16 @@ declare namespace Kendra {
|
|
|
2993
3055
|
SourceS3Path?: S3Path;
|
|
2994
3056
|
}
|
|
2995
3057
|
export type Url = string;
|
|
3058
|
+
export interface Urls {
|
|
3059
|
+
/**
|
|
3060
|
+
* Provides the 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 webpages link to. You can list up to 100 seed URLs.
|
|
3061
|
+
*/
|
|
3062
|
+
SeedUrlConfiguration?: SeedUrlConfiguration;
|
|
3063
|
+
/**
|
|
3064
|
+
* Provides the configuration of the sitemap URLs of the websites you want to crawl. Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.
|
|
3065
|
+
*/
|
|
3066
|
+
SiteMapsConfiguration?: SiteMapsConfiguration;
|
|
3067
|
+
}
|
|
2996
3068
|
export type UserAccount = string;
|
|
2997
3069
|
export interface UserContext {
|
|
2998
3070
|
/**
|
|
@@ -3017,6 +3089,45 @@ declare namespace Kendra {
|
|
|
3017
3089
|
export type ValueImportanceMapKey = string;
|
|
3018
3090
|
export type VisitorId = string;
|
|
3019
3091
|
export type VpcSecurityGroupId = string;
|
|
3092
|
+
export interface WebCrawlerConfiguration {
|
|
3093
|
+
/**
|
|
3094
|
+
* 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. 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 the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
|
|
3095
|
+
*/
|
|
3096
|
+
Urls: Urls;
|
|
3097
|
+
/**
|
|
3098
|
+
* 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 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1. The default crawl depth is set to 2.
|
|
3099
|
+
*/
|
|
3100
|
+
CrawlDepth?: CrawlDepth;
|
|
3101
|
+
/**
|
|
3102
|
+
* The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage. As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance. The default maximum links per page is 100.
|
|
3103
|
+
*/
|
|
3104
|
+
MaxLinksPerPage?: MaxLinksPerPage;
|
|
3105
|
+
/**
|
|
3106
|
+
* The maximum size (in MB) of a webpage or attachment to crawl. Files larger than this size (in MB) are skipped/not crawled. The default maximum size of a webpage or attachment is set to 50 MB.
|
|
3107
|
+
*/
|
|
3108
|
+
MaxContentSizePerPageInMegaBytes?: MaxContentSizePerPageInMegaBytes;
|
|
3109
|
+
/**
|
|
3110
|
+
* The maximum number of URLs crawled per website host per minute. A minimum of one URL is required. The default maximum number of URLs crawled per website host per minute is 300.
|
|
3111
|
+
*/
|
|
3112
|
+
MaxUrlsPerMinuteCrawlRate?: MaxUrlsPerMinuteCrawlRate;
|
|
3113
|
+
/**
|
|
3114
|
+
* The regular expression pattern to include certain URLs to crawl. If there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.
|
|
3115
|
+
*/
|
|
3116
|
+
UrlInclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3117
|
+
/**
|
|
3118
|
+
* The regular expression pattern to exclude certain URLs to crawl. If there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.
|
|
3119
|
+
*/
|
|
3120
|
+
UrlExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3121
|
+
/**
|
|
3122
|
+
* Provides configuration information required to connect to your internal websites via a web proxy. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager.
|
|
3123
|
+
*/
|
|
3124
|
+
ProxyConfiguration?: ProxyConfiguration;
|
|
3125
|
+
/**
|
|
3126
|
+
* Provides configuration information required to connect to websites using authentication. You can connect to websites using basic authentication of user name and password. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. You use a secret in AWS Secrets Manager to store your authentication credentials.
|
|
3127
|
+
*/
|
|
3128
|
+
AuthenticationConfiguration?: AuthenticationConfiguration;
|
|
3129
|
+
}
|
|
3130
|
+
export type WebCrawlerMode = "HOST_ONLY"|"SUBDOMAINS"|"EVERYTHING"|string;
|
|
3020
3131
|
/**
|
|
3021
3132
|
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|
|
3022
3133
|
*/
|