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.
- package/CHANGELOG.md +26 -1
- package/README.md +1 -1
- package/apis/autoscaling-2011-01-01.min.json +63 -60
- package/apis/datasync-2018-11-09.min.json +16 -15
- package/apis/devicefarm-2015-06-23.min.json +144 -92
- package/apis/docdb-2014-10-31.min.json +233 -65
- package/apis/docdb-2014-10-31.paginators.json +6 -0
- package/apis/ec2-2016-11-15.min.json +6 -0
- package/apis/fsx-2018-03-01.min.json +27 -24
- package/apis/iotevents-2018-07-27.min.json +715 -188
- package/apis/iotevents-data-2018-10-23.min.json +380 -1
- package/apis/iotsitewise-2019-12-02.min.json +65 -43
- package/apis/iotwireless-2020-11-22.min.json +210 -6
- package/apis/kendra-2019-02-03.min.json +351 -77
- package/apis/location-2020-11-19.min.json +677 -84
- package/apis/location-2020-11-19.paginators.json +12 -0
- package/apis/sns-2010-03-31.min.json +150 -13
- package/apis/sns-2010-03-31.paginators.json +12 -0
- package/clients/autoscaling.d.ts +55 -50
- package/clients/braket.d.ts +2 -2
- package/clients/datasync.d.ts +39 -34
- package/clients/devicefarm.d.ts +41 -10
- package/clients/docdb.d.ts +217 -4
- package/clients/ec2.d.ts +8 -0
- package/clients/ecs.d.ts +4 -4
- package/clients/fsx.d.ts +15 -2
- package/clients/iam.d.ts +1 -1
- package/clients/iotevents.d.ts +595 -11
- package/clients/ioteventsdata.d.ts +474 -9
- package/clients/iotsitewise.d.ts +34 -0
- package/clients/iotwireless.d.ts +126 -0
- package/clients/kendra.d.ts +410 -6
- package/clients/lightsail.d.ts +3 -3
- package/clients/location.d.ts +651 -77
- package/clients/polly.d.ts +1 -1
- package/clients/resourcegroups.d.ts +4 -4
- package/clients/servicediscovery.d.ts +41 -41
- package/clients/sns.d.ts +181 -4
- package/clients/sqs.d.ts +5 -5
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +17 -17
- package/dist/aws-sdk.js +378 -168
- package/dist/aws-sdk.min.js +68 -68
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/location.d.ts
CHANGED
|
@@ -20,11 +20,19 @@ declare class Location extends Service {
|
|
|
20
20
|
*/
|
|
21
21
|
associateTrackerConsumer(callback?: (err: AWSError, data: Location.Types.AssociateTrackerConsumerResponse) => void): Request<Location.Types.AssociateTrackerConsumerResponse, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
* Deletes
|
|
23
|
+
* Deletes the position history of one or more devices from a tracker resource.
|
|
24
|
+
*/
|
|
25
|
+
batchDeleteDevicePositionHistory(params: Location.Types.BatchDeleteDevicePositionHistoryRequest, callback?: (err: AWSError, data: Location.Types.BatchDeleteDevicePositionHistoryResponse) => void): Request<Location.Types.BatchDeleteDevicePositionHistoryResponse, AWSError>;
|
|
26
|
+
/**
|
|
27
|
+
* Deletes the position history of one or more devices from a tracker resource.
|
|
28
|
+
*/
|
|
29
|
+
batchDeleteDevicePositionHistory(callback?: (err: AWSError, data: Location.Types.BatchDeleteDevicePositionHistoryResponse) => void): Request<Location.Types.BatchDeleteDevicePositionHistoryResponse, AWSError>;
|
|
30
|
+
/**
|
|
31
|
+
* Deletes a batch of geofences from a geofence collection. This operation deletes the resource permanently.
|
|
24
32
|
*/
|
|
25
33
|
batchDeleteGeofence(params: Location.Types.BatchDeleteGeofenceRequest, callback?: (err: AWSError, data: Location.Types.BatchDeleteGeofenceResponse) => void): Request<Location.Types.BatchDeleteGeofenceResponse, AWSError>;
|
|
26
34
|
/**
|
|
27
|
-
* Deletes a batch of geofences from a geofence collection. This
|
|
35
|
+
* Deletes a batch of geofences from a geofence collection. This operation deletes the resource permanently.
|
|
28
36
|
*/
|
|
29
37
|
batchDeleteGeofence(callback?: (err: AWSError, data: Location.Types.BatchDeleteGeofenceResponse) => void): Request<Location.Types.BatchDeleteGeofenceResponse, AWSError>;
|
|
30
38
|
/**
|
|
@@ -44,21 +52,29 @@ declare class Location extends Service {
|
|
|
44
52
|
*/
|
|
45
53
|
batchGetDevicePosition(callback?: (err: AWSError, data: Location.Types.BatchGetDevicePositionResponse) => void): Request<Location.Types.BatchGetDevicePositionResponse, AWSError>;
|
|
46
54
|
/**
|
|
47
|
-
* A batch request for storing geofence geometries into a given geofence collection.
|
|
55
|
+
* A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
|
|
48
56
|
*/
|
|
49
57
|
batchPutGeofence(params: Location.Types.BatchPutGeofenceRequest, callback?: (err: AWSError, data: Location.Types.BatchPutGeofenceResponse) => void): Request<Location.Types.BatchPutGeofenceResponse, AWSError>;
|
|
50
58
|
/**
|
|
51
|
-
* A batch request for storing geofence geometries into a given geofence collection.
|
|
59
|
+
* A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
|
|
52
60
|
*/
|
|
53
61
|
batchPutGeofence(callback?: (err: AWSError, data: Location.Types.BatchPutGeofenceResponse) => void): Request<Location.Types.BatchPutGeofenceResponse, AWSError>;
|
|
54
62
|
/**
|
|
55
|
-
* Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history. Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval
|
|
63
|
+
* Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history. Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval and retained for 30 days before it's deleted.
|
|
56
64
|
*/
|
|
57
65
|
batchUpdateDevicePosition(params: Location.Types.BatchUpdateDevicePositionRequest, callback?: (err: AWSError, data: Location.Types.BatchUpdateDevicePositionResponse) => void): Request<Location.Types.BatchUpdateDevicePositionResponse, AWSError>;
|
|
58
66
|
/**
|
|
59
|
-
* Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history. Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval
|
|
67
|
+
* Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history. Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval and retained for 30 days before it's deleted.
|
|
60
68
|
*/
|
|
61
69
|
batchUpdateDevicePosition(callback?: (err: AWSError, data: Location.Types.BatchUpdateDevicePositionResponse) => void): Request<Location.Types.BatchUpdateDevicePositionResponse, AWSError>;
|
|
70
|
+
/**
|
|
71
|
+
* Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition. Requires that you first create aroute calculator resource By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route. Additional options include: Specifying a departure time using either DepartureTime or DepartureNow. This calculates a route based on predictive traffic data at the given time. You can't specify both DepartureTime and DepartureNow in a single request. Specifying both parameters returns an error message. Specifying a travel mode using TravelMode. This lets you specify additional route preference such as CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
|
|
72
|
+
*/
|
|
73
|
+
calculateRoute(params: Location.Types.CalculateRouteRequest, callback?: (err: AWSError, data: Location.Types.CalculateRouteResponse) => void): Request<Location.Types.CalculateRouteResponse, AWSError>;
|
|
74
|
+
/**
|
|
75
|
+
* Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition. Requires that you first create aroute calculator resource By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route. Additional options include: Specifying a departure time using either DepartureTime or DepartureNow. This calculates a route based on predictive traffic data at the given time. You can't specify both DepartureTime and DepartureNow in a single request. Specifying both parameters returns an error message. Specifying a travel mode using TravelMode. This lets you specify additional route preference such as CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
|
|
76
|
+
*/
|
|
77
|
+
calculateRoute(callback?: (err: AWSError, data: Location.Types.CalculateRouteResponse) => void): Request<Location.Types.CalculateRouteResponse, AWSError>;
|
|
62
78
|
/**
|
|
63
79
|
* Creates a geofence collection, which manages and stores geofences.
|
|
64
80
|
*/
|
|
@@ -68,21 +84,29 @@ declare class Location extends Service {
|
|
|
68
84
|
*/
|
|
69
85
|
createGeofenceCollection(callback?: (err: AWSError, data: Location.Types.CreateGeofenceCollectionResponse) => void): Request<Location.Types.CreateGeofenceCollectionResponse, AWSError>;
|
|
70
86
|
/**
|
|
71
|
-
* Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
|
|
87
|
+
* Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
|
|
72
88
|
*/
|
|
73
89
|
createMap(params: Location.Types.CreateMapRequest, callback?: (err: AWSError, data: Location.Types.CreateMapResponse) => void): Request<Location.Types.CreateMapResponse, AWSError>;
|
|
74
90
|
/**
|
|
75
|
-
* Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
|
|
91
|
+
* Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
|
|
76
92
|
*/
|
|
77
93
|
createMap(callback?: (err: AWSError, data: Location.Types.CreateMapResponse) => void): Request<Location.Types.CreateMapResponse, AWSError>;
|
|
78
94
|
/**
|
|
79
|
-
* Creates a
|
|
95
|
+
* Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider.
|
|
80
96
|
*/
|
|
81
97
|
createPlaceIndex(params: Location.Types.CreatePlaceIndexRequest, callback?: (err: AWSError, data: Location.Types.CreatePlaceIndexResponse) => void): Request<Location.Types.CreatePlaceIndexResponse, AWSError>;
|
|
82
98
|
/**
|
|
83
|
-
* Creates a
|
|
99
|
+
* Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider.
|
|
84
100
|
*/
|
|
85
101
|
createPlaceIndex(callback?: (err: AWSError, data: Location.Types.CreatePlaceIndexResponse) => void): Request<Location.Types.CreatePlaceIndexResponse, AWSError>;
|
|
102
|
+
/**
|
|
103
|
+
* Creates a route calculator resource in your AWS account. You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
|
|
104
|
+
*/
|
|
105
|
+
createRouteCalculator(params: Location.Types.CreateRouteCalculatorRequest, callback?: (err: AWSError, data: Location.Types.CreateRouteCalculatorResponse) => void): Request<Location.Types.CreateRouteCalculatorResponse, AWSError>;
|
|
106
|
+
/**
|
|
107
|
+
* Creates a route calculator resource in your AWS account. You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
|
|
108
|
+
*/
|
|
109
|
+
createRouteCalculator(callback?: (err: AWSError, data: Location.Types.CreateRouteCalculatorResponse) => void): Request<Location.Types.CreateRouteCalculatorResponse, AWSError>;
|
|
86
110
|
/**
|
|
87
111
|
* Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
|
|
88
112
|
*/
|
|
@@ -92,35 +116,43 @@ declare class Location extends Service {
|
|
|
92
116
|
*/
|
|
93
117
|
createTracker(callback?: (err: AWSError, data: Location.Types.CreateTrackerResponse) => void): Request<Location.Types.CreateTrackerResponse, AWSError>;
|
|
94
118
|
/**
|
|
95
|
-
* Deletes a geofence collection from your AWS account. This
|
|
119
|
+
* Deletes a geofence collection from your AWS account. This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
|
|
96
120
|
*/
|
|
97
121
|
deleteGeofenceCollection(params: Location.Types.DeleteGeofenceCollectionRequest, callback?: (err: AWSError, data: Location.Types.DeleteGeofenceCollectionResponse) => void): Request<Location.Types.DeleteGeofenceCollectionResponse, AWSError>;
|
|
98
122
|
/**
|
|
99
|
-
* Deletes a geofence collection from your AWS account. This
|
|
123
|
+
* Deletes a geofence collection from your AWS account. This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
|
|
100
124
|
*/
|
|
101
125
|
deleteGeofenceCollection(callback?: (err: AWSError, data: Location.Types.DeleteGeofenceCollectionResponse) => void): Request<Location.Types.DeleteGeofenceCollectionResponse, AWSError>;
|
|
102
126
|
/**
|
|
103
|
-
* Deletes a map resource from your AWS account. This
|
|
127
|
+
* Deletes a map resource from your AWS account. This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
|
|
104
128
|
*/
|
|
105
129
|
deleteMap(params: Location.Types.DeleteMapRequest, callback?: (err: AWSError, data: Location.Types.DeleteMapResponse) => void): Request<Location.Types.DeleteMapResponse, AWSError>;
|
|
106
130
|
/**
|
|
107
|
-
* Deletes a map resource from your AWS account. This
|
|
131
|
+
* Deletes a map resource from your AWS account. This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
|
|
108
132
|
*/
|
|
109
133
|
deleteMap(callback?: (err: AWSError, data: Location.Types.DeleteMapResponse) => void): Request<Location.Types.DeleteMapResponse, AWSError>;
|
|
110
134
|
/**
|
|
111
|
-
* Deletes a
|
|
135
|
+
* Deletes a place index resource from your AWS account. This operation deletes the resource permanently.
|
|
112
136
|
*/
|
|
113
137
|
deletePlaceIndex(params: Location.Types.DeletePlaceIndexRequest, callback?: (err: AWSError, data: Location.Types.DeletePlaceIndexResponse) => void): Request<Location.Types.DeletePlaceIndexResponse, AWSError>;
|
|
114
138
|
/**
|
|
115
|
-
* Deletes a
|
|
139
|
+
* Deletes a place index resource from your AWS account. This operation deletes the resource permanently.
|
|
116
140
|
*/
|
|
117
141
|
deletePlaceIndex(callback?: (err: AWSError, data: Location.Types.DeletePlaceIndexResponse) => void): Request<Location.Types.DeletePlaceIndexResponse, AWSError>;
|
|
118
142
|
/**
|
|
119
|
-
* Deletes a
|
|
143
|
+
* Deletes a route calculator resource from your AWS account. This operation deletes the resource permanently.
|
|
144
|
+
*/
|
|
145
|
+
deleteRouteCalculator(params: Location.Types.DeleteRouteCalculatorRequest, callback?: (err: AWSError, data: Location.Types.DeleteRouteCalculatorResponse) => void): Request<Location.Types.DeleteRouteCalculatorResponse, AWSError>;
|
|
146
|
+
/**
|
|
147
|
+
* Deletes a route calculator resource from your AWS account. This operation deletes the resource permanently.
|
|
148
|
+
*/
|
|
149
|
+
deleteRouteCalculator(callback?: (err: AWSError, data: Location.Types.DeleteRouteCalculatorResponse) => void): Request<Location.Types.DeleteRouteCalculatorResponse, AWSError>;
|
|
150
|
+
/**
|
|
151
|
+
* Deletes a tracker resource from your AWS account. This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.
|
|
120
152
|
*/
|
|
121
153
|
deleteTracker(params: Location.Types.DeleteTrackerRequest, callback?: (err: AWSError, data: Location.Types.DeleteTrackerResponse) => void): Request<Location.Types.DeleteTrackerResponse, AWSError>;
|
|
122
154
|
/**
|
|
123
|
-
* Deletes a tracker resource from your AWS account. This
|
|
155
|
+
* Deletes a tracker resource from your AWS account. This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.
|
|
124
156
|
*/
|
|
125
157
|
deleteTracker(callback?: (err: AWSError, data: Location.Types.DeleteTrackerResponse) => void): Request<Location.Types.DeleteTrackerResponse, AWSError>;
|
|
126
158
|
/**
|
|
@@ -140,13 +172,21 @@ declare class Location extends Service {
|
|
|
140
172
|
*/
|
|
141
173
|
describeMap(callback?: (err: AWSError, data: Location.Types.DescribeMapResponse) => void): Request<Location.Types.DescribeMapResponse, AWSError>;
|
|
142
174
|
/**
|
|
143
|
-
* Retrieves the
|
|
175
|
+
* Retrieves the place index resource details.
|
|
144
176
|
*/
|
|
145
177
|
describePlaceIndex(params: Location.Types.DescribePlaceIndexRequest, callback?: (err: AWSError, data: Location.Types.DescribePlaceIndexResponse) => void): Request<Location.Types.DescribePlaceIndexResponse, AWSError>;
|
|
146
178
|
/**
|
|
147
|
-
* Retrieves the
|
|
179
|
+
* Retrieves the place index resource details.
|
|
148
180
|
*/
|
|
149
181
|
describePlaceIndex(callback?: (err: AWSError, data: Location.Types.DescribePlaceIndexResponse) => void): Request<Location.Types.DescribePlaceIndexResponse, AWSError>;
|
|
182
|
+
/**
|
|
183
|
+
* Retrieves the route calculator resource details.
|
|
184
|
+
*/
|
|
185
|
+
describeRouteCalculator(params: Location.Types.DescribeRouteCalculatorRequest, callback?: (err: AWSError, data: Location.Types.DescribeRouteCalculatorResponse) => void): Request<Location.Types.DescribeRouteCalculatorResponse, AWSError>;
|
|
186
|
+
/**
|
|
187
|
+
* Retrieves the route calculator resource details.
|
|
188
|
+
*/
|
|
189
|
+
describeRouteCalculator(callback?: (err: AWSError, data: Location.Types.DescribeRouteCalculatorResponse) => void): Request<Location.Types.DescribeRouteCalculatorResponse, AWSError>;
|
|
150
190
|
/**
|
|
151
191
|
* Retrieves the tracker resource details.
|
|
152
192
|
*/
|
|
@@ -164,19 +204,19 @@ declare class Location extends Service {
|
|
|
164
204
|
*/
|
|
165
205
|
disassociateTrackerConsumer(callback?: (err: AWSError, data: Location.Types.DisassociateTrackerConsumerResponse) => void): Request<Location.Types.DisassociateTrackerConsumerResponse, AWSError>;
|
|
166
206
|
/**
|
|
167
|
-
* Retrieves a device's most recent position according to its sample time. Device positions are deleted after
|
|
207
|
+
* Retrieves a device's most recent position according to its sample time. Device positions are deleted after 30 days.
|
|
168
208
|
*/
|
|
169
209
|
getDevicePosition(params: Location.Types.GetDevicePositionRequest, callback?: (err: AWSError, data: Location.Types.GetDevicePositionResponse) => void): Request<Location.Types.GetDevicePositionResponse, AWSError>;
|
|
170
210
|
/**
|
|
171
|
-
* Retrieves a device's most recent position according to its sample time. Device positions are deleted after
|
|
211
|
+
* Retrieves a device's most recent position according to its sample time. Device positions are deleted after 30 days.
|
|
172
212
|
*/
|
|
173
213
|
getDevicePosition(callback?: (err: AWSError, data: Location.Types.GetDevicePositionResponse) => void): Request<Location.Types.GetDevicePositionResponse, AWSError>;
|
|
174
214
|
/**
|
|
175
|
-
* Retrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after
|
|
215
|
+
* Retrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after 30 days.
|
|
176
216
|
*/
|
|
177
217
|
getDevicePositionHistory(params: Location.Types.GetDevicePositionHistoryRequest, callback?: (err: AWSError, data: Location.Types.GetDevicePositionHistoryResponse) => void): Request<Location.Types.GetDevicePositionHistoryResponse, AWSError>;
|
|
178
218
|
/**
|
|
179
|
-
* Retrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after
|
|
219
|
+
* Retrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after 30 days.
|
|
180
220
|
*/
|
|
181
221
|
getDevicePositionHistory(callback?: (err: AWSError, data: Location.Types.GetDevicePositionHistoryResponse) => void): Request<Location.Types.GetDevicePositionHistoryResponse, AWSError>;
|
|
182
222
|
/**
|
|
@@ -212,13 +252,21 @@ declare class Location extends Service {
|
|
|
212
252
|
*/
|
|
213
253
|
getMapStyleDescriptor(callback?: (err: AWSError, data: Location.Types.GetMapStyleDescriptorResponse) => void): Request<Location.Types.GetMapStyleDescriptorResponse, AWSError>;
|
|
214
254
|
/**
|
|
215
|
-
* Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map.
|
|
255
|
+
* Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
|
|
216
256
|
*/
|
|
217
257
|
getMapTile(params: Location.Types.GetMapTileRequest, callback?: (err: AWSError, data: Location.Types.GetMapTileResponse) => void): Request<Location.Types.GetMapTileResponse, AWSError>;
|
|
218
258
|
/**
|
|
219
|
-
* Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map.
|
|
259
|
+
* Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
|
|
220
260
|
*/
|
|
221
261
|
getMapTile(callback?: (err: AWSError, data: Location.Types.GetMapTileResponse) => void): Request<Location.Types.GetMapTileResponse, AWSError>;
|
|
262
|
+
/**
|
|
263
|
+
* Lists the latest device positions for requested devices.
|
|
264
|
+
*/
|
|
265
|
+
listDevicePositions(params: Location.Types.ListDevicePositionsRequest, callback?: (err: AWSError, data: Location.Types.ListDevicePositionsResponse) => void): Request<Location.Types.ListDevicePositionsResponse, AWSError>;
|
|
266
|
+
/**
|
|
267
|
+
* Lists the latest device positions for requested devices.
|
|
268
|
+
*/
|
|
269
|
+
listDevicePositions(callback?: (err: AWSError, data: Location.Types.ListDevicePositionsResponse) => void): Request<Location.Types.ListDevicePositionsResponse, AWSError>;
|
|
222
270
|
/**
|
|
223
271
|
* Lists geofence collections in your AWS account.
|
|
224
272
|
*/
|
|
@@ -244,13 +292,29 @@ declare class Location extends Service {
|
|
|
244
292
|
*/
|
|
245
293
|
listMaps(callback?: (err: AWSError, data: Location.Types.ListMapsResponse) => void): Request<Location.Types.ListMapsResponse, AWSError>;
|
|
246
294
|
/**
|
|
247
|
-
* Lists
|
|
295
|
+
* Lists place index resources in your AWS account.
|
|
248
296
|
*/
|
|
249
297
|
listPlaceIndexes(params: Location.Types.ListPlaceIndexesRequest, callback?: (err: AWSError, data: Location.Types.ListPlaceIndexesResponse) => void): Request<Location.Types.ListPlaceIndexesResponse, AWSError>;
|
|
250
298
|
/**
|
|
251
|
-
* Lists
|
|
299
|
+
* Lists place index resources in your AWS account.
|
|
252
300
|
*/
|
|
253
301
|
listPlaceIndexes(callback?: (err: AWSError, data: Location.Types.ListPlaceIndexesResponse) => void): Request<Location.Types.ListPlaceIndexesResponse, AWSError>;
|
|
302
|
+
/**
|
|
303
|
+
* Lists route calculator resources in your AWS account.
|
|
304
|
+
*/
|
|
305
|
+
listRouteCalculators(params: Location.Types.ListRouteCalculatorsRequest, callback?: (err: AWSError, data: Location.Types.ListRouteCalculatorsResponse) => void): Request<Location.Types.ListRouteCalculatorsResponse, AWSError>;
|
|
306
|
+
/**
|
|
307
|
+
* Lists route calculator resources in your AWS account.
|
|
308
|
+
*/
|
|
309
|
+
listRouteCalculators(callback?: (err: AWSError, data: Location.Types.ListRouteCalculatorsResponse) => void): Request<Location.Types.ListRouteCalculatorsResponse, AWSError>;
|
|
310
|
+
/**
|
|
311
|
+
* Returns the tags for the specified Amazon Location Service resource.
|
|
312
|
+
*/
|
|
313
|
+
listTagsForResource(params: Location.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Location.Types.ListTagsForResourceResponse) => void): Request<Location.Types.ListTagsForResourceResponse, AWSError>;
|
|
314
|
+
/**
|
|
315
|
+
* Returns the tags for the specified Amazon Location Service resource.
|
|
316
|
+
*/
|
|
317
|
+
listTagsForResource(callback?: (err: AWSError, data: Location.Types.ListTagsForResourceResponse) => void): Request<Location.Types.ListTagsForResourceResponse, AWSError>;
|
|
254
318
|
/**
|
|
255
319
|
* Lists geofence collections currently associated to the given tracker resource.
|
|
256
320
|
*/
|
|
@@ -276,28 +340,44 @@ declare class Location extends Service {
|
|
|
276
340
|
*/
|
|
277
341
|
putGeofence(callback?: (err: AWSError, data: Location.Types.PutGeofenceResponse) => void): Request<Location.Types.PutGeofenceResponse, AWSError>;
|
|
278
342
|
/**
|
|
279
|
-
* Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
|
|
343
|
+
* Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
|
|
280
344
|
*/
|
|
281
345
|
searchPlaceIndexForPosition(params: Location.Types.SearchPlaceIndexForPositionRequest, callback?: (err: AWSError, data: Location.Types.SearchPlaceIndexForPositionResponse) => void): Request<Location.Types.SearchPlaceIndexForPositionResponse, AWSError>;
|
|
282
346
|
/**
|
|
283
|
-
* Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
|
|
347
|
+
* Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
|
|
284
348
|
*/
|
|
285
349
|
searchPlaceIndexForPosition(callback?: (err: AWSError, data: Location.Types.SearchPlaceIndexForPositionResponse) => void): Request<Location.Types.SearchPlaceIndexForPositionResponse, AWSError>;
|
|
286
350
|
/**
|
|
287
|
-
* Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest. Includes the option to apply additional parameters to narrow your list of results. You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
|
|
351
|
+
* Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest. Includes the option to apply additional parameters to narrow your list of results. You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
|
|
288
352
|
*/
|
|
289
353
|
searchPlaceIndexForText(params: Location.Types.SearchPlaceIndexForTextRequest, callback?: (err: AWSError, data: Location.Types.SearchPlaceIndexForTextResponse) => void): Request<Location.Types.SearchPlaceIndexForTextResponse, AWSError>;
|
|
290
354
|
/**
|
|
291
|
-
* Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest. Includes the option to apply additional parameters to narrow your list of results. You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
|
|
355
|
+
* Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest. Includes the option to apply additional parameters to narrow your list of results. You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
|
|
292
356
|
*/
|
|
293
357
|
searchPlaceIndexForText(callback?: (err: AWSError, data: Location.Types.SearchPlaceIndexForTextResponse) => void): Request<Location.Types.SearchPlaceIndexForTextResponse, AWSError>;
|
|
358
|
+
/**
|
|
359
|
+
* Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource. <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate as many as 50 tags with a resource.</p>
|
|
360
|
+
*/
|
|
361
|
+
tagResource(params: Location.Types.TagResourceRequest, callback?: (err: AWSError, data: Location.Types.TagResourceResponse) => void): Request<Location.Types.TagResourceResponse, AWSError>;
|
|
362
|
+
/**
|
|
363
|
+
* Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource. <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate as many as 50 tags with a resource.</p>
|
|
364
|
+
*/
|
|
365
|
+
tagResource(callback?: (err: AWSError, data: Location.Types.TagResourceResponse) => void): Request<Location.Types.TagResourceResponse, AWSError>;
|
|
366
|
+
/**
|
|
367
|
+
* Removes one or more tags from the specified Amazon Location Service resource.
|
|
368
|
+
*/
|
|
369
|
+
untagResource(params: Location.Types.UntagResourceRequest, callback?: (err: AWSError, data: Location.Types.UntagResourceResponse) => void): Request<Location.Types.UntagResourceResponse, AWSError>;
|
|
370
|
+
/**
|
|
371
|
+
* Removes one or more tags from the specified Amazon Location Service resource.
|
|
372
|
+
*/
|
|
373
|
+
untagResource(callback?: (err: AWSError, data: Location.Types.UntagResourceResponse) => void): Request<Location.Types.UntagResourceResponse, AWSError>;
|
|
294
374
|
}
|
|
295
375
|
declare namespace Location {
|
|
296
376
|
export type Arn = string;
|
|
297
377
|
export type ArnList = Arn[];
|
|
298
378
|
export interface AssociateTrackerConsumerRequest {
|
|
299
379
|
/**
|
|
300
|
-
* The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS.
|
|
380
|
+
* The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
|
|
301
381
|
*/
|
|
302
382
|
ConsumerArn: Arn;
|
|
303
383
|
/**
|
|
@@ -307,6 +387,31 @@ declare namespace Location {
|
|
|
307
387
|
}
|
|
308
388
|
export interface AssociateTrackerConsumerResponse {
|
|
309
389
|
}
|
|
390
|
+
export interface BatchDeleteDevicePositionHistoryError {
|
|
391
|
+
/**
|
|
392
|
+
* The ID of the device for this position.
|
|
393
|
+
*/
|
|
394
|
+
DeviceId: Id;
|
|
395
|
+
Error: BatchItemError;
|
|
396
|
+
}
|
|
397
|
+
export type BatchDeleteDevicePositionHistoryErrorList = BatchDeleteDevicePositionHistoryError[];
|
|
398
|
+
export interface BatchDeleteDevicePositionHistoryRequest {
|
|
399
|
+
/**
|
|
400
|
+
* Devices whose position history you want to delete. For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
|
|
401
|
+
*/
|
|
402
|
+
DeviceIds: BatchDeleteDevicePositionHistoryRequestDeviceIdsList;
|
|
403
|
+
/**
|
|
404
|
+
* The name of the tracker resource to delete the device position history from.
|
|
405
|
+
*/
|
|
406
|
+
TrackerName: ResourceName;
|
|
407
|
+
}
|
|
408
|
+
export type BatchDeleteDevicePositionHistoryRequestDeviceIdsList = Id[];
|
|
409
|
+
export interface BatchDeleteDevicePositionHistoryResponse {
|
|
410
|
+
/**
|
|
411
|
+
* Contains error details for each device history that failed to delete.
|
|
412
|
+
*/
|
|
413
|
+
Errors: BatchDeleteDevicePositionHistoryErrorList;
|
|
414
|
+
}
|
|
310
415
|
export interface BatchDeleteGeofenceError {
|
|
311
416
|
/**
|
|
312
417
|
* Contains details associated to the batch error.
|
|
@@ -501,12 +606,122 @@ declare namespace Location {
|
|
|
501
606
|
Errors: BatchUpdateDevicePositionErrorList;
|
|
502
607
|
}
|
|
503
608
|
export type _Blob = Buffer|Uint8Array|Blob|string;
|
|
609
|
+
export type Boolean = boolean;
|
|
504
610
|
export type BoundingBox = Double[];
|
|
611
|
+
export interface CalculateRouteCarModeOptions {
|
|
612
|
+
/**
|
|
613
|
+
* Avoids ferries when calculating routes. Default Value: false Valid Values: false | true
|
|
614
|
+
*/
|
|
615
|
+
AvoidFerries?: Boolean;
|
|
616
|
+
/**
|
|
617
|
+
* Avoids tolls when calculating routes. Default Value: false Valid Values: false | true
|
|
618
|
+
*/
|
|
619
|
+
AvoidTolls?: Boolean;
|
|
620
|
+
}
|
|
621
|
+
export interface CalculateRouteRequest {
|
|
622
|
+
/**
|
|
623
|
+
* The name of the route calculator resource that you want to use to calculate a route.
|
|
624
|
+
*/
|
|
625
|
+
CalculatorName: ResourceName;
|
|
626
|
+
/**
|
|
627
|
+
* Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls. Requirements: TravelMode must be specified as Car.
|
|
628
|
+
*/
|
|
629
|
+
CarModeOptions?: CalculateRouteCarModeOptions;
|
|
630
|
+
/**
|
|
631
|
+
* Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route. Default Value: false Valid Values: false | true
|
|
632
|
+
*/
|
|
633
|
+
DepartNow?: Boolean;
|
|
634
|
+
/**
|
|
635
|
+
* The start position for the route. Defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285] If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. Valid Values: [-180 to 180,-90 to 90]
|
|
636
|
+
*/
|
|
637
|
+
DeparturePosition: Position;
|
|
638
|
+
/**
|
|
639
|
+
* Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route. Setting a departure time in the past returns a 400 ValidationException error. In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
|
|
640
|
+
*/
|
|
641
|
+
DepartureTime?: Timestamp;
|
|
642
|
+
/**
|
|
643
|
+
* The finish position for the route. Defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615] If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. Valid Values: [-180 to 180,-90 to 90]
|
|
644
|
+
*/
|
|
645
|
+
DestinationPosition: Position;
|
|
646
|
+
/**
|
|
647
|
+
* Set the unit system to specify the distance. Default Value: Kilometers
|
|
648
|
+
*/
|
|
649
|
+
DistanceUnit?: DistanceUnit;
|
|
650
|
+
/**
|
|
651
|
+
* Set to include the geometry details in the result for each path between a pair of positions. Default Value: false Valid Values: false | true
|
|
652
|
+
*/
|
|
653
|
+
IncludeLegGeometry?: Boolean;
|
|
654
|
+
/**
|
|
655
|
+
* Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. The TravelMode you specify determines how you specify route preferences: If traveling by Car use the CarModeOptions parameter. If traveling by Truck use the TruckModeOptions parameter. Default Value: Car
|
|
656
|
+
*/
|
|
657
|
+
TravelMode?: TravelMode;
|
|
658
|
+
/**
|
|
659
|
+
* Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road. Requirements: TravelMode must be specified as Truck.
|
|
660
|
+
*/
|
|
661
|
+
TruckModeOptions?: CalculateRouteTruckModeOptions;
|
|
662
|
+
/**
|
|
663
|
+
* Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]] If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road. Specifying more than 23 waypoints returns a 400 ValidationException error. Valid Values: [-180 to 180,-90 to 90]
|
|
664
|
+
*/
|
|
665
|
+
WaypointPositions?: CalculateRouteRequestWaypointPositionsList;
|
|
666
|
+
}
|
|
667
|
+
export type CalculateRouteRequestWaypointPositionsList = Position[];
|
|
668
|
+
export interface CalculateRouteResponse {
|
|
669
|
+
/**
|
|
670
|
+
* Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one less than the total number of positions in the request. For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road: The StartPosition is the departure position. The EndPosition is the destination position. A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road.: Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon. Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
|
|
671
|
+
*/
|
|
672
|
+
Legs: LegList;
|
|
673
|
+
/**
|
|
674
|
+
* Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds
|
|
675
|
+
*/
|
|
676
|
+
Summary: CalculateRouteSummary;
|
|
677
|
+
}
|
|
678
|
+
export interface CalculateRouteSummary {
|
|
679
|
+
/**
|
|
680
|
+
* The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers: Esri Here For more information about data providers, see Amazon Location Service data providers.
|
|
681
|
+
*/
|
|
682
|
+
DataSource: String;
|
|
683
|
+
/**
|
|
684
|
+
* The total distance covered by the route. The sum of the distance travelled between every stop on the route. The route distance can't be greater than 250 km. If the route exceeds 250 km, the response returns a 400 RoutesValidationException error.
|
|
685
|
+
*/
|
|
686
|
+
Distance: CalculateRouteSummaryDistanceDouble;
|
|
687
|
+
/**
|
|
688
|
+
* The unit of measurement for the distance.
|
|
689
|
+
*/
|
|
690
|
+
DistanceUnit: DistanceUnit;
|
|
691
|
+
/**
|
|
692
|
+
* The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
|
|
693
|
+
*/
|
|
694
|
+
DurationSeconds: CalculateRouteSummaryDurationSecondsDouble;
|
|
695
|
+
/**
|
|
696
|
+
* Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y] The first 2 bbox parameters describe the lower southwest corner: The first bbox position is the X coordinate or longitude of the lower southwest corner. The second bbox position is the Y coordinate or latitude of the lower southwest corner. The next 2 bbox parameters describe the upper northeast corner: The third bbox position is the X coordinate, or longitude of the upper northeast corner. The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
|
|
697
|
+
*/
|
|
698
|
+
RouteBBox: BoundingBox;
|
|
699
|
+
}
|
|
700
|
+
export type CalculateRouteSummaryDistanceDouble = number;
|
|
701
|
+
export type CalculateRouteSummaryDurationSecondsDouble = number;
|
|
702
|
+
export interface CalculateRouteTruckModeOptions {
|
|
703
|
+
/**
|
|
704
|
+
* Avoids ferries when calculating routes. Default Value: false Valid Values: false | true
|
|
705
|
+
*/
|
|
706
|
+
AvoidFerries?: Boolean;
|
|
707
|
+
/**
|
|
708
|
+
* Avoids ferries when calculating routes. Default Value: false Valid Values: false | true
|
|
709
|
+
*/
|
|
710
|
+
AvoidTolls?: Boolean;
|
|
711
|
+
/**
|
|
712
|
+
* Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
|
|
713
|
+
*/
|
|
714
|
+
Dimensions?: TruckDimensions;
|
|
715
|
+
/**
|
|
716
|
+
* Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
|
|
717
|
+
*/
|
|
718
|
+
Weight?: TruckWeight;
|
|
719
|
+
}
|
|
505
720
|
export type CountryCode = string;
|
|
506
721
|
export type CountryCodeList = CountryCode[];
|
|
507
722
|
export interface CreateGeofenceCollectionRequest {
|
|
508
723
|
/**
|
|
509
|
-
* A custom name for the geofence collection. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0
|
|
724
|
+
* A custom name for the geofence collection. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique geofence collection name. No spaces allowed. For example, ExampleGeofenceCollection.
|
|
510
725
|
*/
|
|
511
726
|
CollectionName: ResourceName;
|
|
512
727
|
/**
|
|
@@ -514,17 +729,25 @@ declare namespace Location {
|
|
|
514
729
|
*/
|
|
515
730
|
Description?: ResourceDescription;
|
|
516
731
|
/**
|
|
517
|
-
*
|
|
732
|
+
* A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
|
|
733
|
+
*/
|
|
734
|
+
KmsKeyId?: KmsKeyId;
|
|
735
|
+
/**
|
|
736
|
+
* Specifies the pricing plan for the geofence collection. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
|
|
518
737
|
*/
|
|
519
738
|
PricingPlan: PricingPlan;
|
|
520
739
|
/**
|
|
521
|
-
* Specifies the
|
|
740
|
+
* Specifies the data provider for the geofence collection. Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page. Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account or Region unless you move it. Valid Values: Esri | Here
|
|
522
741
|
*/
|
|
523
742
|
PricingPlanDataSource?: String;
|
|
743
|
+
/**
|
|
744
|
+
* Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: "key" : "value" Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
|
|
745
|
+
*/
|
|
746
|
+
Tags?: TagMap;
|
|
524
747
|
}
|
|
525
748
|
export interface CreateGeofenceCollectionResponse {
|
|
526
749
|
/**
|
|
527
|
-
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
|
|
750
|
+
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
|
|
528
751
|
*/
|
|
529
752
|
CollectionArn: Arn;
|
|
530
753
|
/**
|
|
@@ -553,6 +776,10 @@ declare namespace Location {
|
|
|
553
776
|
* Specifies the pricing plan for your map resource. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
|
|
554
777
|
*/
|
|
555
778
|
PricingPlan: PricingPlan;
|
|
779
|
+
/**
|
|
780
|
+
* Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: "key" : "value" Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
|
|
781
|
+
*/
|
|
782
|
+
Tags?: TagMap;
|
|
556
783
|
}
|
|
557
784
|
export interface CreateMapResponse {
|
|
558
785
|
/**
|
|
@@ -560,7 +787,7 @@ declare namespace Location {
|
|
|
560
787
|
*/
|
|
561
788
|
CreateTime: Timestamp;
|
|
562
789
|
/**
|
|
563
|
-
* The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS. Format example: arn:
|
|
790
|
+
* The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:maps/ExampleMap
|
|
564
791
|
*/
|
|
565
792
|
MapArn: Arn;
|
|
566
793
|
/**
|
|
@@ -570,7 +797,7 @@ declare namespace Location {
|
|
|
570
797
|
}
|
|
571
798
|
export interface CreatePlaceIndexRequest {
|
|
572
799
|
/**
|
|
573
|
-
* Specifies the data provider of geospatial data. This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error. Valid values include: Esri Here For additional details on data providers, see the Amazon Location Service data providers page.
|
|
800
|
+
* Specifies the data provider of geospatial data. This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error. Valid values include: Esri Here Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service. For additional details on data providers, see the Amazon Location Service data providers page.
|
|
574
801
|
*/
|
|
575
802
|
DataSource: String;
|
|
576
803
|
/**
|
|
@@ -578,45 +805,93 @@ declare namespace Location {
|
|
|
578
805
|
*/
|
|
579
806
|
DataSourceConfiguration?: DataSourceConfiguration;
|
|
580
807
|
/**
|
|
581
|
-
* The optional description for the
|
|
808
|
+
* The optional description for the place index resource.
|
|
582
809
|
*/
|
|
583
810
|
Description?: ResourceDescription;
|
|
584
811
|
/**
|
|
585
|
-
* The name of the
|
|
812
|
+
* The name of the place index resource. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique place index resource name. No spaces allowed. For example, ExamplePlaceIndex.
|
|
586
813
|
*/
|
|
587
814
|
IndexName: ResourceName;
|
|
588
815
|
/**
|
|
589
|
-
* Specifies the pricing plan for your
|
|
816
|
+
* Specifies the pricing plan for your place index resource. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
|
|
590
817
|
*/
|
|
591
818
|
PricingPlan: PricingPlan;
|
|
819
|
+
/**
|
|
820
|
+
* Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: "key" : "value" Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
|
|
821
|
+
*/
|
|
822
|
+
Tags?: TagMap;
|
|
592
823
|
}
|
|
593
824
|
export interface CreatePlaceIndexResponse {
|
|
594
825
|
/**
|
|
595
|
-
* The timestamp for when the
|
|
826
|
+
* The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
|
|
596
827
|
*/
|
|
597
828
|
CreateTime: Timestamp;
|
|
598
829
|
/**
|
|
599
|
-
* The Amazon Resource Name (ARN) for the
|
|
830
|
+
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
|
|
600
831
|
*/
|
|
601
832
|
IndexArn: Arn;
|
|
602
833
|
/**
|
|
603
|
-
* The name for the
|
|
834
|
+
* The name for the place index resource.
|
|
604
835
|
*/
|
|
605
836
|
IndexName: ResourceName;
|
|
606
837
|
}
|
|
838
|
+
export interface CreateRouteCalculatorRequest {
|
|
839
|
+
/**
|
|
840
|
+
* The name of the route calculator resource. Requirements: Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_). Must be a unique Route calculator resource name. No spaces allowed. For example, ExampleRouteCalculator.
|
|
841
|
+
*/
|
|
842
|
+
CalculatorName: ResourceName;
|
|
843
|
+
/**
|
|
844
|
+
* Specifies the data provider of traffic and road network data. This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error. Valid Values: Esri | Here For more information about data providers, see Amazon Location Service data providers.
|
|
845
|
+
*/
|
|
846
|
+
DataSource: String;
|
|
847
|
+
/**
|
|
848
|
+
* The optional description for the route calculator resource.
|
|
849
|
+
*/
|
|
850
|
+
Description?: ResourceDescription;
|
|
851
|
+
/**
|
|
852
|
+
* Specifies the pricing plan for your route calculator resource. For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
|
|
853
|
+
*/
|
|
854
|
+
PricingPlan: PricingPlan;
|
|
855
|
+
/**
|
|
856
|
+
* Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. For example: { "tag1" : "value1", "tag2" : "value2"} Format: "key" : "value" Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
|
|
857
|
+
*/
|
|
858
|
+
Tags?: TagMap;
|
|
859
|
+
}
|
|
860
|
+
export interface CreateRouteCalculatorResponse {
|
|
861
|
+
/**
|
|
862
|
+
* The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
|
|
863
|
+
*/
|
|
864
|
+
CalculatorArn: Arn;
|
|
865
|
+
/**
|
|
866
|
+
* The name of the route calculator resource. For example, ExampleRouteCalculator.
|
|
867
|
+
*/
|
|
868
|
+
CalculatorName: ResourceName;
|
|
869
|
+
/**
|
|
870
|
+
* The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
|
|
871
|
+
*/
|
|
872
|
+
CreateTime: Timestamp;
|
|
873
|
+
}
|
|
607
874
|
export interface CreateTrackerRequest {
|
|
608
875
|
/**
|
|
609
876
|
* An optional description for the tracker resource.
|
|
610
877
|
*/
|
|
611
878
|
Description?: ResourceDescription;
|
|
612
879
|
/**
|
|
613
|
-
*
|
|
880
|
+
* A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
|
|
881
|
+
*/
|
|
882
|
+
KmsKeyId?: KmsKeyId;
|
|
883
|
+
/**
|
|
884
|
+
* Specifies the pricing plan for the tracker resource. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
|
|
614
885
|
*/
|
|
615
886
|
PricingPlan: PricingPlan;
|
|
616
887
|
/**
|
|
617
|
-
* Specifies the
|
|
888
|
+
* Specifies the data provider for the tracker resource. Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page. Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it. Valid Values: Esri | Here
|
|
618
889
|
*/
|
|
619
890
|
PricingPlanDataSource?: String;
|
|
891
|
+
/**
|
|
892
|
+
* Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: "key" : "value" Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
|
|
893
|
+
*/
|
|
894
|
+
Tags?: TagMap;
|
|
620
895
|
/**
|
|
621
896
|
* The name for the tracker resource. Requirements: Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). Must be a unique tracker resource name. No spaces allowed. For example, ExampleTracker.
|
|
622
897
|
*/
|
|
@@ -628,7 +903,7 @@ declare namespace Location {
|
|
|
628
903
|
*/
|
|
629
904
|
CreateTime: Timestamp;
|
|
630
905
|
/**
|
|
631
|
-
* The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
|
|
906
|
+
* The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
|
|
632
907
|
*/
|
|
633
908
|
TrackerArn: Arn;
|
|
634
909
|
/**
|
|
@@ -638,7 +913,7 @@ declare namespace Location {
|
|
|
638
913
|
}
|
|
639
914
|
export interface DataSourceConfiguration {
|
|
640
915
|
/**
|
|
641
|
-
* Specifies how the results of an operation will be stored by the caller. Valid values include: SingleUse specifies that the results won't be stored. Storage specifies that the result can be cached or stored in a database.
|
|
916
|
+
* Specifies how the results of an operation will be stored by the caller. Valid values include: SingleUse specifies that the results won't be stored. Storage specifies that the result can be cached or stored in a database. Place index resources using HERE as a data provider can't be configured to store results for locations in Japan when choosing Storage for the IntendedUse parameter. Default value: SingleUse
|
|
642
917
|
*/
|
|
643
918
|
IntendedUse?: IntendedUse;
|
|
644
919
|
}
|
|
@@ -660,12 +935,20 @@ declare namespace Location {
|
|
|
660
935
|
}
|
|
661
936
|
export interface DeletePlaceIndexRequest {
|
|
662
937
|
/**
|
|
663
|
-
* The name of the
|
|
938
|
+
* The name of the place index resource to be deleted.
|
|
664
939
|
*/
|
|
665
940
|
IndexName: ResourceName;
|
|
666
941
|
}
|
|
667
942
|
export interface DeletePlaceIndexResponse {
|
|
668
943
|
}
|
|
944
|
+
export interface DeleteRouteCalculatorRequest {
|
|
945
|
+
/**
|
|
946
|
+
* The name of the route calculator resource to be deleted.
|
|
947
|
+
*/
|
|
948
|
+
CalculatorName: ResourceName;
|
|
949
|
+
}
|
|
950
|
+
export interface DeleteRouteCalculatorResponse {
|
|
951
|
+
}
|
|
669
952
|
export interface DeleteTrackerRequest {
|
|
670
953
|
/**
|
|
671
954
|
* The name of the tracker resource to be deleted.
|
|
@@ -682,7 +965,7 @@ declare namespace Location {
|
|
|
682
965
|
}
|
|
683
966
|
export interface DescribeGeofenceCollectionResponse {
|
|
684
967
|
/**
|
|
685
|
-
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
|
|
968
|
+
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
|
|
686
969
|
*/
|
|
687
970
|
CollectionArn: Arn;
|
|
688
971
|
/**
|
|
@@ -697,14 +980,22 @@ declare namespace Location {
|
|
|
697
980
|
* The optional description for the geofence collection.
|
|
698
981
|
*/
|
|
699
982
|
Description: ResourceDescription;
|
|
983
|
+
/**
|
|
984
|
+
* A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource
|
|
985
|
+
*/
|
|
986
|
+
KmsKeyId?: KmsKeyId;
|
|
700
987
|
/**
|
|
701
988
|
* The pricing plan selected for the specified geofence collection. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
|
|
702
989
|
*/
|
|
703
990
|
PricingPlan: PricingPlan;
|
|
704
991
|
/**
|
|
705
|
-
* The data
|
|
992
|
+
* The specified data provider for the geofence collection.
|
|
706
993
|
*/
|
|
707
994
|
PricingPlanDataSource?: String;
|
|
995
|
+
/**
|
|
996
|
+
* Displays the key, value pairs of tags associated with this resource.
|
|
997
|
+
*/
|
|
998
|
+
Tags?: TagMap;
|
|
708
999
|
/**
|
|
709
1000
|
* The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
|
|
710
1001
|
*/
|
|
@@ -734,7 +1025,7 @@ declare namespace Location {
|
|
|
734
1025
|
*/
|
|
735
1026
|
Description: ResourceDescription;
|
|
736
1027
|
/**
|
|
737
|
-
* The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
|
|
1028
|
+
* The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:maps/ExampleMap
|
|
738
1029
|
*/
|
|
739
1030
|
MapArn: Arn;
|
|
740
1031
|
/**
|
|
@@ -745,6 +1036,10 @@ declare namespace Location {
|
|
|
745
1036
|
* The pricing plan selected for the specified map resource. <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</p>
|
|
746
1037
|
*/
|
|
747
1038
|
PricingPlan: PricingPlan;
|
|
1039
|
+
/**
|
|
1040
|
+
* Tags associated with the map resource.
|
|
1041
|
+
*/
|
|
1042
|
+
Tags?: TagMap;
|
|
748
1043
|
/**
|
|
749
1044
|
* The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
|
|
750
1045
|
*/
|
|
@@ -752,13 +1047,13 @@ declare namespace Location {
|
|
|
752
1047
|
}
|
|
753
1048
|
export interface DescribePlaceIndexRequest {
|
|
754
1049
|
/**
|
|
755
|
-
* The name of the
|
|
1050
|
+
* The name of the place index resource.
|
|
756
1051
|
*/
|
|
757
1052
|
IndexName: ResourceName;
|
|
758
1053
|
}
|
|
759
1054
|
export interface DescribePlaceIndexResponse {
|
|
760
1055
|
/**
|
|
761
|
-
* The timestamp for when the
|
|
1056
|
+
* The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
|
|
762
1057
|
*/
|
|
763
1058
|
CreateTime: Timestamp;
|
|
764
1059
|
/**
|
|
@@ -770,23 +1065,67 @@ declare namespace Location {
|
|
|
770
1065
|
*/
|
|
771
1066
|
DataSourceConfiguration: DataSourceConfiguration;
|
|
772
1067
|
/**
|
|
773
|
-
* The optional description for the
|
|
1068
|
+
* The optional description for the place index resource.
|
|
774
1069
|
*/
|
|
775
1070
|
Description: ResourceDescription;
|
|
776
1071
|
/**
|
|
777
|
-
* The Amazon Resource Name (ARN) for the
|
|
1072
|
+
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
|
|
778
1073
|
*/
|
|
779
1074
|
IndexArn: Arn;
|
|
780
1075
|
/**
|
|
781
|
-
* The name of the
|
|
1076
|
+
* The name of the place index resource being described.
|
|
782
1077
|
*/
|
|
783
1078
|
IndexName: ResourceName;
|
|
784
1079
|
/**
|
|
785
|
-
* The pricing plan selected for the specified
|
|
1080
|
+
* The pricing plan selected for the specified place index resource. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
|
|
786
1081
|
*/
|
|
787
1082
|
PricingPlan: PricingPlan;
|
|
788
1083
|
/**
|
|
789
|
-
*
|
|
1084
|
+
* Tags associated with place index resource.
|
|
1085
|
+
*/
|
|
1086
|
+
Tags?: TagMap;
|
|
1087
|
+
/**
|
|
1088
|
+
* The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
|
|
1089
|
+
*/
|
|
1090
|
+
UpdateTime: Timestamp;
|
|
1091
|
+
}
|
|
1092
|
+
export interface DescribeRouteCalculatorRequest {
|
|
1093
|
+
/**
|
|
1094
|
+
* The name of the route calculator resource.
|
|
1095
|
+
*/
|
|
1096
|
+
CalculatorName: ResourceName;
|
|
1097
|
+
}
|
|
1098
|
+
export interface DescribeRouteCalculatorResponse {
|
|
1099
|
+
/**
|
|
1100
|
+
* The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS. Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
|
|
1101
|
+
*/
|
|
1102
|
+
CalculatorArn: Arn;
|
|
1103
|
+
/**
|
|
1104
|
+
* The name of the route calculator resource being described.
|
|
1105
|
+
*/
|
|
1106
|
+
CalculatorName: ResourceName;
|
|
1107
|
+
/**
|
|
1108
|
+
* The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
|
|
1109
|
+
*/
|
|
1110
|
+
CreateTime: Timestamp;
|
|
1111
|
+
/**
|
|
1112
|
+
* The data provider of traffic and road network data. Indicates one of the available providers: Esri Here For more information about data providers, see Amazon Location Service data providers.
|
|
1113
|
+
*/
|
|
1114
|
+
DataSource: String;
|
|
1115
|
+
/**
|
|
1116
|
+
* The optional description of the route calculator resource.
|
|
1117
|
+
*/
|
|
1118
|
+
Description: ResourceDescription;
|
|
1119
|
+
/**
|
|
1120
|
+
* The pricing plan selected for the specified route calculator resource. For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
|
|
1121
|
+
*/
|
|
1122
|
+
PricingPlan: PricingPlan;
|
|
1123
|
+
/**
|
|
1124
|
+
* Tags associated with route calculator resource.
|
|
1125
|
+
*/
|
|
1126
|
+
Tags?: TagMap;
|
|
1127
|
+
/**
|
|
1128
|
+
* The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
|
|
790
1129
|
*/
|
|
791
1130
|
UpdateTime: Timestamp;
|
|
792
1131
|
}
|
|
@@ -805,16 +1144,24 @@ declare namespace Location {
|
|
|
805
1144
|
* The optional description for the tracker resource.
|
|
806
1145
|
*/
|
|
807
1146
|
Description: ResourceDescription;
|
|
1147
|
+
/**
|
|
1148
|
+
* A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
|
|
1149
|
+
*/
|
|
1150
|
+
KmsKeyId?: KmsKeyId;
|
|
808
1151
|
/**
|
|
809
1152
|
* The pricing plan selected for the specified tracker resource. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
|
|
810
1153
|
*/
|
|
811
1154
|
PricingPlan: PricingPlan;
|
|
812
1155
|
/**
|
|
813
|
-
* The data
|
|
1156
|
+
* The specified data provider for the tracker resource.
|
|
814
1157
|
*/
|
|
815
1158
|
PricingPlanDataSource?: String;
|
|
816
1159
|
/**
|
|
817
|
-
* The
|
|
1160
|
+
* The tags associated with the tracker resource.
|
|
1161
|
+
*/
|
|
1162
|
+
Tags?: TagMap;
|
|
1163
|
+
/**
|
|
1164
|
+
* The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
|
|
818
1165
|
*/
|
|
819
1166
|
TrackerArn: Arn;
|
|
820
1167
|
/**
|
|
@@ -859,9 +1206,10 @@ declare namespace Location {
|
|
|
859
1206
|
*/
|
|
860
1207
|
SampleTime: Timestamp;
|
|
861
1208
|
}
|
|
1209
|
+
export type DimensionUnit = "Meters"|"Feet"|string;
|
|
862
1210
|
export interface DisassociateTrackerConsumerRequest {
|
|
863
1211
|
/**
|
|
864
|
-
* The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS. Format example: arn:
|
|
1212
|
+
* The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
|
|
865
1213
|
*/
|
|
866
1214
|
ConsumerArn: Arn;
|
|
867
1215
|
/**
|
|
@@ -871,6 +1219,7 @@ declare namespace Location {
|
|
|
871
1219
|
}
|
|
872
1220
|
export interface DisassociateTrackerConsumerResponse {
|
|
873
1221
|
}
|
|
1222
|
+
export type DistanceUnit = "Kilometers"|"Miles"|string;
|
|
874
1223
|
export type Double = number;
|
|
875
1224
|
export interface GeofenceGeometry {
|
|
876
1225
|
/**
|
|
@@ -906,7 +1255,7 @@ declare namespace Location {
|
|
|
906
1255
|
*/
|
|
907
1256
|
DevicePositions: DevicePositionList;
|
|
908
1257
|
/**
|
|
909
|
-
* A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
|
|
1258
|
+
* A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
|
|
910
1259
|
*/
|
|
911
1260
|
NextToken?: Token;
|
|
912
1261
|
}
|
|
@@ -976,7 +1325,7 @@ declare namespace Location {
|
|
|
976
1325
|
*/
|
|
977
1326
|
FontStack: String;
|
|
978
1327
|
/**
|
|
979
|
-
* A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0
|
|
1328
|
+
* A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.
|
|
980
1329
|
*/
|
|
981
1330
|
FontUnicodeRange: GetMapGlyphsRequestFontUnicodeRangeString;
|
|
982
1331
|
/**
|
|
@@ -1065,8 +1414,85 @@ declare namespace Location {
|
|
|
1065
1414
|
}
|
|
1066
1415
|
export type Id = string;
|
|
1067
1416
|
export type IntendedUse = "SingleUse"|"Storage"|string;
|
|
1417
|
+
export type KmsKeyId = string;
|
|
1418
|
+
export interface Leg {
|
|
1419
|
+
/**
|
|
1420
|
+
* The distance between the leg's StartPosition and EndPosition along a calculated route. The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
|
|
1421
|
+
*/
|
|
1422
|
+
Distance: LegDistanceDouble;
|
|
1423
|
+
/**
|
|
1424
|
+
* The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.
|
|
1425
|
+
*/
|
|
1426
|
+
DurationSeconds: LegDurationSecondsDouble;
|
|
1427
|
+
/**
|
|
1428
|
+
* The terminating position of the leg. Follows the format [longitude,latitude]. If the EndPosition isn't located on a road, it's snapped to a nearby road.
|
|
1429
|
+
*/
|
|
1430
|
+
EndPosition: Position;
|
|
1431
|
+
/**
|
|
1432
|
+
* Contains the calculated route's path as a linestring geometry.
|
|
1433
|
+
*/
|
|
1434
|
+
Geometry?: LegGeometry;
|
|
1435
|
+
/**
|
|
1436
|
+
* The starting position of the leg. Follows the format [longitude,latitude]. If the StartPosition isn't located on a road, it's snapped to a nearby road.
|
|
1437
|
+
*/
|
|
1438
|
+
StartPosition: Position;
|
|
1439
|
+
/**
|
|
1440
|
+
* Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
|
|
1441
|
+
*/
|
|
1442
|
+
Steps: StepList;
|
|
1443
|
+
}
|
|
1444
|
+
export type LegDistanceDouble = number;
|
|
1445
|
+
export type LegDurationSecondsDouble = number;
|
|
1446
|
+
export interface LegGeometry {
|
|
1447
|
+
/**
|
|
1448
|
+
* An ordered list of positions used to plot a route on a map. The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg. For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
|
|
1449
|
+
*/
|
|
1450
|
+
LineString?: LineString;
|
|
1451
|
+
}
|
|
1452
|
+
export type LegList = Leg[];
|
|
1453
|
+
export type LineString = Position[];
|
|
1068
1454
|
export type LinearRing = Position[];
|
|
1069
1455
|
export type LinearRings = LinearRing[];
|
|
1456
|
+
export interface ListDevicePositionsRequest {
|
|
1457
|
+
/**
|
|
1458
|
+
* An optional limit for the number of entries returned in a single call. Default value: 100
|
|
1459
|
+
*/
|
|
1460
|
+
MaxResults?: ListDevicePositionsRequestMaxResultsInteger;
|
|
1461
|
+
/**
|
|
1462
|
+
* The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: null
|
|
1463
|
+
*/
|
|
1464
|
+
NextToken?: Token;
|
|
1465
|
+
/**
|
|
1466
|
+
* The tracker resource containing the requested devices.
|
|
1467
|
+
*/
|
|
1468
|
+
TrackerName: ResourceName;
|
|
1469
|
+
}
|
|
1470
|
+
export type ListDevicePositionsRequestMaxResultsInteger = number;
|
|
1471
|
+
export interface ListDevicePositionsResponse {
|
|
1472
|
+
/**
|
|
1473
|
+
* Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.
|
|
1474
|
+
*/
|
|
1475
|
+
Entries: ListDevicePositionsResponseEntryList;
|
|
1476
|
+
/**
|
|
1477
|
+
* A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
|
|
1478
|
+
*/
|
|
1479
|
+
NextToken?: Token;
|
|
1480
|
+
}
|
|
1481
|
+
export interface ListDevicePositionsResponseEntry {
|
|
1482
|
+
/**
|
|
1483
|
+
* The ID of the device for this position.
|
|
1484
|
+
*/
|
|
1485
|
+
DeviceId: Id;
|
|
1486
|
+
/**
|
|
1487
|
+
* The last known device position. Empty if no positions currently stored.
|
|
1488
|
+
*/
|
|
1489
|
+
Position: Position;
|
|
1490
|
+
/**
|
|
1491
|
+
* The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
|
|
1492
|
+
*/
|
|
1493
|
+
SampleTime: Timestamp;
|
|
1494
|
+
}
|
|
1495
|
+
export type ListDevicePositionsResponseEntryList = ListDevicePositionsResponseEntry[];
|
|
1070
1496
|
export interface ListGeofenceCollectionsRequest {
|
|
1071
1497
|
/**
|
|
1072
1498
|
* An optional limit for the number of resources returned in a single call. Default value: 100
|
|
@@ -1106,7 +1532,7 @@ declare namespace Location {
|
|
|
1106
1532
|
*/
|
|
1107
1533
|
PricingPlan: PricingPlan;
|
|
1108
1534
|
/**
|
|
1109
|
-
* The data
|
|
1535
|
+
* The specified data provider for the geofence collection.
|
|
1110
1536
|
*/
|
|
1111
1537
|
PricingPlanDataSource?: String;
|
|
1112
1538
|
/**
|
|
@@ -1219,7 +1645,7 @@ declare namespace Location {
|
|
|
1219
1645
|
export type ListPlaceIndexesRequestMaxResultsInteger = number;
|
|
1220
1646
|
export interface ListPlaceIndexesResponse {
|
|
1221
1647
|
/**
|
|
1222
|
-
* Lists the
|
|
1648
|
+
* Lists the place index resources that exist in your AWS account
|
|
1223
1649
|
*/
|
|
1224
1650
|
Entries: ListPlaceIndexesResponseEntryList;
|
|
1225
1651
|
/**
|
|
@@ -1229,31 +1655,91 @@ declare namespace Location {
|
|
|
1229
1655
|
}
|
|
1230
1656
|
export interface ListPlaceIndexesResponseEntry {
|
|
1231
1657
|
/**
|
|
1232
|
-
* The timestamp for when the
|
|
1658
|
+
* The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
|
|
1233
1659
|
*/
|
|
1234
1660
|
CreateTime: Timestamp;
|
|
1235
1661
|
/**
|
|
1236
|
-
* The data provider of geospatial data. Indicates one of the available providers:
|
|
1662
|
+
* The data provider of geospatial data. Indicates one of the available providers: Esri Here For additional details on data providers, see the Amazon Location Service data providers page.
|
|
1237
1663
|
*/
|
|
1238
1664
|
DataSource: String;
|
|
1239
1665
|
/**
|
|
1240
|
-
* The optional description for the
|
|
1666
|
+
* The optional description for the place index resource.
|
|
1241
1667
|
*/
|
|
1242
1668
|
Description: ResourceDescription;
|
|
1243
1669
|
/**
|
|
1244
|
-
* The name of the
|
|
1670
|
+
* The name of the place index resource.
|
|
1245
1671
|
*/
|
|
1246
1672
|
IndexName: ResourceName;
|
|
1247
1673
|
/**
|
|
1248
|
-
* The pricing plan for the specified
|
|
1674
|
+
* The pricing plan for the specified place index resource. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
|
|
1249
1675
|
*/
|
|
1250
1676
|
PricingPlan: PricingPlan;
|
|
1251
1677
|
/**
|
|
1252
|
-
* The timestamp for when the
|
|
1678
|
+
* The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
|
|
1253
1679
|
*/
|
|
1254
1680
|
UpdateTime: Timestamp;
|
|
1255
1681
|
}
|
|
1256
1682
|
export type ListPlaceIndexesResponseEntryList = ListPlaceIndexesResponseEntry[];
|
|
1683
|
+
export interface ListRouteCalculatorsRequest {
|
|
1684
|
+
/**
|
|
1685
|
+
* An optional maximum number of results returned in a single call. Default Value: 100
|
|
1686
|
+
*/
|
|
1687
|
+
MaxResults?: ListRouteCalculatorsRequestMaxResultsInteger;
|
|
1688
|
+
/**
|
|
1689
|
+
* The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default Value: null
|
|
1690
|
+
*/
|
|
1691
|
+
NextToken?: Token;
|
|
1692
|
+
}
|
|
1693
|
+
export type ListRouteCalculatorsRequestMaxResultsInteger = number;
|
|
1694
|
+
export interface ListRouteCalculatorsResponse {
|
|
1695
|
+
/**
|
|
1696
|
+
* Lists the route calculator resources that exist in your AWS account
|
|
1697
|
+
*/
|
|
1698
|
+
Entries: ListRouteCalculatorsResponseEntryList;
|
|
1699
|
+
/**
|
|
1700
|
+
* A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.
|
|
1701
|
+
*/
|
|
1702
|
+
NextToken?: Token;
|
|
1703
|
+
}
|
|
1704
|
+
export interface ListRouteCalculatorsResponseEntry {
|
|
1705
|
+
/**
|
|
1706
|
+
* The name of the route calculator resource.
|
|
1707
|
+
*/
|
|
1708
|
+
CalculatorName: ResourceName;
|
|
1709
|
+
/**
|
|
1710
|
+
* The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
|
|
1711
|
+
*/
|
|
1712
|
+
CreateTime: Timestamp;
|
|
1713
|
+
/**
|
|
1714
|
+
* The data provider of traffic and road network data. Indicates one of the available providers: Esri Here For more information about data providers, see Amazon Location Service data providers.
|
|
1715
|
+
*/
|
|
1716
|
+
DataSource: String;
|
|
1717
|
+
/**
|
|
1718
|
+
* The optional description of the route calculator resource.
|
|
1719
|
+
*/
|
|
1720
|
+
Description: ResourceDescription;
|
|
1721
|
+
/**
|
|
1722
|
+
* The pricing plan for the specified route calculator resource. For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
|
|
1723
|
+
*/
|
|
1724
|
+
PricingPlan: PricingPlan;
|
|
1725
|
+
/**
|
|
1726
|
+
* The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
|
|
1727
|
+
*/
|
|
1728
|
+
UpdateTime: Timestamp;
|
|
1729
|
+
}
|
|
1730
|
+
export type ListRouteCalculatorsResponseEntryList = ListRouteCalculatorsResponseEntry[];
|
|
1731
|
+
export interface ListTagsForResourceRequest {
|
|
1732
|
+
/**
|
|
1733
|
+
* The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
|
|
1734
|
+
*/
|
|
1735
|
+
ResourceArn: Arn;
|
|
1736
|
+
}
|
|
1737
|
+
export interface ListTagsForResourceResponse {
|
|
1738
|
+
/**
|
|
1739
|
+
* The mapping from tag key to tag value for each tag associated with the specified resource.
|
|
1740
|
+
*/
|
|
1741
|
+
Tags?: TagMap;
|
|
1742
|
+
}
|
|
1257
1743
|
export interface ListTrackerConsumersRequest {
|
|
1258
1744
|
/**
|
|
1259
1745
|
* An optional limit for the number of resources returned in a single call. Default value: 100
|
|
@@ -1314,7 +1800,7 @@ declare namespace Location {
|
|
|
1314
1800
|
*/
|
|
1315
1801
|
PricingPlan: PricingPlan;
|
|
1316
1802
|
/**
|
|
1317
|
-
* The data
|
|
1803
|
+
* The specified data provider for the tracker resource.
|
|
1318
1804
|
*/
|
|
1319
1805
|
PricingPlanDataSource?: String;
|
|
1320
1806
|
/**
|
|
@@ -1329,7 +1815,7 @@ declare namespace Location {
|
|
|
1329
1815
|
export type ListTrackersResponseEntryList = ListTrackersResponseEntry[];
|
|
1330
1816
|
export interface MapConfiguration {
|
|
1331
1817
|
/**
|
|
1332
|
-
* Specifies the map style selected from an available data provider. Valid styles: VectorEsriStreets, VectorEsriTopographic, VectorEsriNavigation, VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas, VectorHereBerlin. When using HERE as your data provider, and selecting the Style VectorHereBerlin, you may not use HERE Maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
|
|
1818
|
+
* Specifies the map style selected from an available data provider. Valid styles: RasterEsriImagery, VectorEsriStreets, VectorEsriTopographic, VectorEsriNavigation, VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas, VectorHereBerlin. When using HERE as your data provider, and selecting the Style VectorHereBerlin, you may not use HERE Maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
|
|
1333
1819
|
*/
|
|
1334
1820
|
Style: MapStyle;
|
|
1335
1821
|
}
|
|
@@ -1428,7 +1914,7 @@ declare namespace Location {
|
|
|
1428
1914
|
export type SearchForTextResultList = SearchForTextResult[];
|
|
1429
1915
|
export interface SearchPlaceIndexForPositionRequest {
|
|
1430
1916
|
/**
|
|
1431
|
-
* The name of the
|
|
1917
|
+
* The name of the place index resource you want to use for the search.
|
|
1432
1918
|
*/
|
|
1433
1919
|
IndexName: ResourceName;
|
|
1434
1920
|
/**
|
|
@@ -1478,7 +1964,7 @@ declare namespace Location {
|
|
|
1478
1964
|
*/
|
|
1479
1965
|
FilterCountries?: CountryCodeList;
|
|
1480
1966
|
/**
|
|
1481
|
-
* The name of the
|
|
1967
|
+
* The name of the place index resource you want to use for the search.
|
|
1482
1968
|
*/
|
|
1483
1969
|
IndexName: ResourceName;
|
|
1484
1970
|
/**
|
|
@@ -1530,11 +2016,99 @@ declare namespace Location {
|
|
|
1530
2016
|
*/
|
|
1531
2017
|
Text: SyntheticSearchPlaceIndexForTextSummaryString;
|
|
1532
2018
|
}
|
|
2019
|
+
export interface Step {
|
|
2020
|
+
/**
|
|
2021
|
+
* The travel distance between the step's StartPosition and EndPosition.
|
|
2022
|
+
*/
|
|
2023
|
+
Distance: StepDistanceDouble;
|
|
2024
|
+
/**
|
|
2025
|
+
* The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.
|
|
2026
|
+
*/
|
|
2027
|
+
DurationSeconds: StepDurationSecondsDouble;
|
|
2028
|
+
/**
|
|
2029
|
+
* The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.
|
|
2030
|
+
*/
|
|
2031
|
+
EndPosition: Position;
|
|
2032
|
+
/**
|
|
2033
|
+
* Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0. Included in the response for queries that set IncludeLegGeometry to True.
|
|
2034
|
+
*/
|
|
2035
|
+
GeometryOffset?: StepGeometryOffsetInteger;
|
|
2036
|
+
/**
|
|
2037
|
+
* The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.
|
|
2038
|
+
*/
|
|
2039
|
+
StartPosition: Position;
|
|
2040
|
+
}
|
|
2041
|
+
export type StepDistanceDouble = number;
|
|
2042
|
+
export type StepDurationSecondsDouble = number;
|
|
2043
|
+
export type StepGeometryOffsetInteger = number;
|
|
2044
|
+
export type StepList = Step[];
|
|
1533
2045
|
export type String = string;
|
|
1534
2046
|
export type SyntheticSearchPlaceIndexForTextRequestString = string;
|
|
1535
2047
|
export type SyntheticSearchPlaceIndexForTextSummaryString = string;
|
|
2048
|
+
export type TagKey = string;
|
|
2049
|
+
export type TagKeys = String[];
|
|
2050
|
+
export type TagMap = {[key: string]: TagValue};
|
|
2051
|
+
export interface TagResourceRequest {
|
|
2052
|
+
/**
|
|
2053
|
+
* The Amazon Resource Name (ARN) of the resource whose tags you want to update.
|
|
2054
|
+
*/
|
|
2055
|
+
ResourceArn: Arn;
|
|
2056
|
+
/**
|
|
2057
|
+
* The mapping from tag key to tag value for each tag associated with the specified resource.
|
|
2058
|
+
*/
|
|
2059
|
+
Tags: TagMap;
|
|
2060
|
+
}
|
|
2061
|
+
export interface TagResourceResponse {
|
|
2062
|
+
}
|
|
2063
|
+
export type TagValue = string;
|
|
1536
2064
|
export type Timestamp = Date;
|
|
1537
2065
|
export type Token = string;
|
|
2066
|
+
export type TravelMode = "Car"|"Truck"|"Walking"|string;
|
|
2067
|
+
export interface TruckDimensions {
|
|
2068
|
+
/**
|
|
2069
|
+
* The height of the truck. For example, 4.5.
|
|
2070
|
+
*/
|
|
2071
|
+
Height?: TruckDimensionsHeightDouble;
|
|
2072
|
+
/**
|
|
2073
|
+
* The length of the truck. For example, 15.5.
|
|
2074
|
+
*/
|
|
2075
|
+
Length?: TruckDimensionsLengthDouble;
|
|
2076
|
+
/**
|
|
2077
|
+
* Specifies the unit of measurement for the truck dimensions. Default Value: Meters
|
|
2078
|
+
*/
|
|
2079
|
+
Unit?: DimensionUnit;
|
|
2080
|
+
/**
|
|
2081
|
+
* The width of the truck. For example, 4.5.
|
|
2082
|
+
*/
|
|
2083
|
+
Width?: TruckDimensionsWidthDouble;
|
|
2084
|
+
}
|
|
2085
|
+
export type TruckDimensionsHeightDouble = number;
|
|
2086
|
+
export type TruckDimensionsLengthDouble = number;
|
|
2087
|
+
export type TruckDimensionsWidthDouble = number;
|
|
2088
|
+
export interface TruckWeight {
|
|
2089
|
+
/**
|
|
2090
|
+
* The total weight of the truck. For example, 3500.
|
|
2091
|
+
*/
|
|
2092
|
+
Total?: TruckWeightTotalDouble;
|
|
2093
|
+
/**
|
|
2094
|
+
* The unit of measurement to use for the truck weight. Default Value: Kilograms
|
|
2095
|
+
*/
|
|
2096
|
+
Unit?: VehicleWeightUnit;
|
|
2097
|
+
}
|
|
2098
|
+
export type TruckWeightTotalDouble = number;
|
|
2099
|
+
export interface UntagResourceRequest {
|
|
2100
|
+
/**
|
|
2101
|
+
* The Amazon Resource Name (ARN) of the resource from which you want to remove tags.
|
|
2102
|
+
*/
|
|
2103
|
+
ResourceArn: Arn;
|
|
2104
|
+
/**
|
|
2105
|
+
* The list of tag keys to remove from the resource.
|
|
2106
|
+
*/
|
|
2107
|
+
TagKeys: TagKeys;
|
|
2108
|
+
}
|
|
2109
|
+
export interface UntagResourceResponse {
|
|
2110
|
+
}
|
|
2111
|
+
export type VehicleWeightUnit = "Kilograms"|"Pounds"|string;
|
|
1538
2112
|
/**
|
|
1539
2113
|
* 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.
|
|
1540
2114
|
*/
|