/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / location.d.ts
location.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class Location extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Location.Types.ClientConfiguration) 13 config: Config & Location.Types.ClientConfiguration; 14 /** 15 * Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. You can associate up to five geofence collections to each tracker resource. Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account. 16 */ 17 associateTrackerConsumer(params: Location.Types.AssociateTrackerConsumerRequest, callback?: (err: AWSError, data: Location.Types.AssociateTrackerConsumerResponse) => void): Request<Location.Types.AssociateTrackerConsumerResponse, AWSError>; 18 /** 19 * Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. You can associate up to five geofence collections to each tracker resource. Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account. 20 */ 21 associateTrackerConsumer(callback?: (err: AWSError, data: Location.Types.AssociateTrackerConsumerResponse) => void): Request<Location.Types.AssociateTrackerConsumerResponse, AWSError>; 22 /** 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. 32 */ 33 batchDeleteGeofence(params: Location.Types.BatchDeleteGeofenceRequest, callback?: (err: AWSError, data: Location.Types.BatchDeleteGeofenceResponse) => void): Request<Location.Types.BatchDeleteGeofenceResponse, AWSError>; 34 /** 35 * Deletes a batch of geofences from a geofence collection. This operation deletes the resource permanently. 36 */ 37 batchDeleteGeofence(callback?: (err: AWSError, data: Location.Types.BatchDeleteGeofenceResponse) => void): Request<Location.Types.BatchDeleteGeofenceResponse, AWSError>; 38 /** 39 * Evaluates device positions against the geofence geometries from a given geofence collection. This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge: ENTER if Amazon Location determines that the tracked device has entered a geofenced area. EXIT if Amazon Location determines that the tracked device has exited a geofenced area. The last geofence that a device was observed within is tracked for 30 days after the most recent device position update. 40 */ 41 batchEvaluateGeofences(params: Location.Types.BatchEvaluateGeofencesRequest, callback?: (err: AWSError, data: Location.Types.BatchEvaluateGeofencesResponse) => void): Request<Location.Types.BatchEvaluateGeofencesResponse, AWSError>; 42 /** 43 * Evaluates device positions against the geofence geometries from a given geofence collection. This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge: ENTER if Amazon Location determines that the tracked device has entered a geofenced area. EXIT if Amazon Location determines that the tracked device has exited a geofenced area. The last geofence that a device was observed within is tracked for 30 days after the most recent device position update. 44 */ 45 batchEvaluateGeofences(callback?: (err: AWSError, data: Location.Types.BatchEvaluateGeofencesResponse) => void): Request<Location.Types.BatchEvaluateGeofencesResponse, AWSError>; 46 /** 47 * Lists the latest device positions for requested devices. 48 */ 49 batchGetDevicePosition(params: Location.Types.BatchGetDevicePositionRequest, callback?: (err: AWSError, data: Location.Types.BatchGetDevicePositionResponse) => void): Request<Location.Types.BatchGetDevicePositionResponse, AWSError>; 50 /** 51 * Lists the latest device positions for requested devices. 52 */ 53 batchGetDevicePosition(callback?: (err: AWSError, data: Location.Types.BatchGetDevicePositionResponse) => void): Request<Location.Types.BatchGetDevicePositionResponse, AWSError>; 54 /** 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. 56 */ 57 batchPutGeofence(params: Location.Types.BatchPutGeofenceRequest, callback?: (err: AWSError, data: Location.Types.BatchPutGeofenceResponse) => void): Request<Location.Types.BatchPutGeofenceResponse, AWSError>; 58 /** 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. 60 */ 61 batchPutGeofence(callback?: (err: AWSError, data: Location.Types.BatchPutGeofenceResponse) => void): Request<Location.Types.BatchPutGeofenceResponse, AWSError>; 62 /** 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. 64 */ 65 batchUpdateDevicePosition(params: Location.Types.BatchUpdateDevicePositionRequest, callback?: (err: AWSError, data: Location.Types.BatchUpdateDevicePositionResponse) => void): Request<Location.Types.BatchUpdateDevicePositionResponse, AWSError>; 66 /** 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. 68 */ 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 a route 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 an 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 a route 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 an 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>; 78 /** 79 * Creates a geofence collection, which manages and stores geofences. 80 */ 81 createGeofenceCollection(params: Location.Types.CreateGeofenceCollectionRequest, callback?: (err: AWSError, data: Location.Types.CreateGeofenceCollectionResponse) => void): Request<Location.Types.CreateGeofenceCollectionResponse, AWSError>; 82 /** 83 * Creates a geofence collection, which manages and stores geofences. 84 */ 85 createGeofenceCollection(callback?: (err: AWSError, data: Location.Types.CreateGeofenceCollectionResponse) => void): Request<Location.Types.CreateGeofenceCollectionResponse, AWSError>; 86 /** 87 * Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers. 88 */ 89 createMap(params: Location.Types.CreateMapRequest, callback?: (err: AWSError, data: Location.Types.CreateMapResponse) => void): Request<Location.Types.CreateMapResponse, AWSError>; 90 /** 91 * Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers. 92 */ 93 createMap(callback?: (err: AWSError, data: Location.Types.CreateMapResponse) => void): Request<Location.Types.CreateMapResponse, AWSError>; 94 /** 95 * Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider. 96 */ 97 createPlaceIndex(params: Location.Types.CreatePlaceIndexRequest, callback?: (err: AWSError, data: Location.Types.CreatePlaceIndexResponse) => void): Request<Location.Types.CreatePlaceIndexResponse, AWSError>; 98 /** 99 * Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider. 100 */ 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>; 110 /** 111 * Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices. 112 */ 113 createTracker(params: Location.Types.CreateTrackerRequest, callback?: (err: AWSError, data: Location.Types.CreateTrackerResponse) => void): Request<Location.Types.CreateTrackerResponse, AWSError>; 114 /** 115 * Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices. 116 */ 117 createTracker(callback?: (err: AWSError, data: Location.Types.CreateTrackerResponse) => void): Request<Location.Types.CreateTrackerResponse, AWSError>; 118 /** 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. 120 */ 121 deleteGeofenceCollection(params: Location.Types.DeleteGeofenceCollectionRequest, callback?: (err: AWSError, data: Location.Types.DeleteGeofenceCollectionResponse) => void): Request<Location.Types.DeleteGeofenceCollectionResponse, AWSError>; 122 /** 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. 124 */ 125 deleteGeofenceCollection(callback?: (err: AWSError, data: Location.Types.DeleteGeofenceCollectionResponse) => void): Request<Location.Types.DeleteGeofenceCollectionResponse, AWSError>; 126 /** 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. 128 */ 129 deleteMap(params: Location.Types.DeleteMapRequest, callback?: (err: AWSError, data: Location.Types.DeleteMapResponse) => void): Request<Location.Types.DeleteMapResponse, AWSError>; 130 /** 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. 132 */ 133 deleteMap(callback?: (err: AWSError, data: Location.Types.DeleteMapResponse) => void): Request<Location.Types.DeleteMapResponse, AWSError>; 134 /** 135 * Deletes a place index resource from your AWS account. This operation deletes the resource permanently. 136 */ 137 deletePlaceIndex(params: Location.Types.DeletePlaceIndexRequest, callback?: (err: AWSError, data: Location.Types.DeletePlaceIndexResponse) => void): Request<Location.Types.DeletePlaceIndexResponse, AWSError>; 138 /** 139 * Deletes a place index resource from your AWS account. This operation deletes the resource permanently. 140 */ 141 deletePlaceIndex(callback?: (err: AWSError, data: Location.Types.DeletePlaceIndexResponse) => void): Request<Location.Types.DeletePlaceIndexResponse, AWSError>; 142 /** 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. 152 */ 153 deleteTracker(params: Location.Types.DeleteTrackerRequest, callback?: (err: AWSError, data: Location.Types.DeleteTrackerResponse) => void): Request<Location.Types.DeleteTrackerResponse, AWSError>; 154 /** 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. 156 */ 157 deleteTracker(callback?: (err: AWSError, data: Location.Types.DeleteTrackerResponse) => void): Request<Location.Types.DeleteTrackerResponse, AWSError>; 158 /** 159 * Retrieves the geofence collection details. 160 */ 161 describeGeofenceCollection(params: Location.Types.DescribeGeofenceCollectionRequest, callback?: (err: AWSError, data: Location.Types.DescribeGeofenceCollectionResponse) => void): Request<Location.Types.DescribeGeofenceCollectionResponse, AWSError>; 162 /** 163 * Retrieves the geofence collection details. 164 */ 165 describeGeofenceCollection(callback?: (err: AWSError, data: Location.Types.DescribeGeofenceCollectionResponse) => void): Request<Location.Types.DescribeGeofenceCollectionResponse, AWSError>; 166 /** 167 * Retrieves the map resource details. 168 */ 169 describeMap(params: Location.Types.DescribeMapRequest, callback?: (err: AWSError, data: Location.Types.DescribeMapResponse) => void): Request<Location.Types.DescribeMapResponse, AWSError>; 170 /** 171 * Retrieves the map resource details. 172 */ 173 describeMap(callback?: (err: AWSError, data: Location.Types.DescribeMapResponse) => void): Request<Location.Types.DescribeMapResponse, AWSError>; 174 /** 175 * Retrieves the place index resource details. 176 */ 177 describePlaceIndex(params: Location.Types.DescribePlaceIndexRequest, callback?: (err: AWSError, data: Location.Types.DescribePlaceIndexResponse) => void): Request<Location.Types.DescribePlaceIndexResponse, AWSError>; 178 /** 179 * Retrieves the place index resource details. 180 */ 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>; 190 /** 191 * Retrieves the tracker resource details. 192 */ 193 describeTracker(params: Location.Types.DescribeTrackerRequest, callback?: (err: AWSError, data: Location.Types.DescribeTrackerResponse) => void): Request<Location.Types.DescribeTrackerResponse, AWSError>; 194 /** 195 * Retrieves the tracker resource details. 196 */ 197 describeTracker(callback?: (err: AWSError, data: Location.Types.DescribeTrackerResponse) => void): Request<Location.Types.DescribeTrackerResponse, AWSError>; 198 /** 199 * Removes the association between a tracker resource and a geofence collection. Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences. 200 */ 201 disassociateTrackerConsumer(params: Location.Types.DisassociateTrackerConsumerRequest, callback?: (err: AWSError, data: Location.Types.DisassociateTrackerConsumerResponse) => void): Request<Location.Types.DisassociateTrackerConsumerResponse, AWSError>; 202 /** 203 * Removes the association between a tracker resource and a geofence collection. Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences. 204 */ 205 disassociateTrackerConsumer(callback?: (err: AWSError, data: Location.Types.DisassociateTrackerConsumerResponse) => void): Request<Location.Types.DisassociateTrackerConsumerResponse, AWSError>; 206 /** 207 * Retrieves a device's most recent position according to its sample time. Device positions are deleted after 30 days. 208 */ 209 getDevicePosition(params: Location.Types.GetDevicePositionRequest, callback?: (err: AWSError, data: Location.Types.GetDevicePositionResponse) => void): Request<Location.Types.GetDevicePositionResponse, AWSError>; 210 /** 211 * Retrieves a device's most recent position according to its sample time. Device positions are deleted after 30 days. 212 */ 213 getDevicePosition(callback?: (err: AWSError, data: Location.Types.GetDevicePositionResponse) => void): Request<Location.Types.GetDevicePositionResponse, AWSError>; 214 /** 215 * Retrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after 30 days. 216 */ 217 getDevicePositionHistory(params: Location.Types.GetDevicePositionHistoryRequest, callback?: (err: AWSError, data: Location.Types.GetDevicePositionHistoryResponse) => void): Request<Location.Types.GetDevicePositionHistoryResponse, AWSError>; 218 /** 219 * Retrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after 30 days. 220 */ 221 getDevicePositionHistory(callback?: (err: AWSError, data: Location.Types.GetDevicePositionHistoryResponse) => void): Request<Location.Types.GetDevicePositionHistoryResponse, AWSError>; 222 /** 223 * Retrieves the geofence details from a geofence collection. 224 */ 225 getGeofence(params: Location.Types.GetGeofenceRequest, callback?: (err: AWSError, data: Location.Types.GetGeofenceResponse) => void): Request<Location.Types.GetGeofenceResponse, AWSError>; 226 /** 227 * Retrieves the geofence details from a geofence collection. 228 */ 229 getGeofence(callback?: (err: AWSError, data: Location.Types.GetGeofenceResponse) => void): Request<Location.Types.GetGeofenceResponse, AWSError>; 230 /** 231 * Retrieves glyphs used to display labels on a map. 232 */ 233 getMapGlyphs(params: Location.Types.GetMapGlyphsRequest, callback?: (err: AWSError, data: Location.Types.GetMapGlyphsResponse) => void): Request<Location.Types.GetMapGlyphsResponse, AWSError>; 234 /** 235 * Retrieves glyphs used to display labels on a map. 236 */ 237 getMapGlyphs(callback?: (err: AWSError, data: Location.Types.GetMapGlyphsResponse) => void): Request<Location.Types.GetMapGlyphsResponse, AWSError>; 238 /** 239 * Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map. 240 */ 241 getMapSprites(params: Location.Types.GetMapSpritesRequest, callback?: (err: AWSError, data: Location.Types.GetMapSpritesResponse) => void): Request<Location.Types.GetMapSpritesResponse, AWSError>; 242 /** 243 * Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map. 244 */ 245 getMapSprites(callback?: (err: AWSError, data: Location.Types.GetMapSpritesResponse) => void): Request<Location.Types.GetMapSpritesResponse, AWSError>; 246 /** 247 * Retrieves the map style descriptor from a map resource. The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification. 248 */ 249 getMapStyleDescriptor(params: Location.Types.GetMapStyleDescriptorRequest, callback?: (err: AWSError, data: Location.Types.GetMapStyleDescriptorResponse) => void): Request<Location.Types.GetMapStyleDescriptorResponse, AWSError>; 250 /** 251 * Retrieves the map style descriptor from a map resource. The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification. 252 */ 253 getMapStyleDescriptor(callback?: (err: AWSError, data: Location.Types.GetMapStyleDescriptorResponse) => void): Request<Location.Types.GetMapStyleDescriptorResponse, AWSError>; 254 /** 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). 256 */ 257 getMapTile(params: Location.Types.GetMapTileRequest, callback?: (err: AWSError, data: Location.Types.GetMapTileResponse) => void): Request<Location.Types.GetMapTileResponse, AWSError>; 258 /** 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). 260 */ 261 getMapTile(callback?: (err: AWSError, data: Location.Types.GetMapTileResponse) => void): Request<Location.Types.GetMapTileResponse, AWSError>; 262 /** 263 * A batch request to retrieve all device positions. 264 */ 265 listDevicePositions(params: Location.Types.ListDevicePositionsRequest, callback?: (err: AWSError, data: Location.Types.ListDevicePositionsResponse) => void): Request<Location.Types.ListDevicePositionsResponse, AWSError>; 266 /** 267 * A batch request to retrieve all device positions. 268 */ 269 listDevicePositions(callback?: (err: AWSError, data: Location.Types.ListDevicePositionsResponse) => void): Request<Location.Types.ListDevicePositionsResponse, AWSError>; 270 /** 271 * Lists geofence collections in your AWS account. 272 */ 273 listGeofenceCollections(params: Location.Types.ListGeofenceCollectionsRequest, callback?: (err: AWSError, data: Location.Types.ListGeofenceCollectionsResponse) => void): Request<Location.Types.ListGeofenceCollectionsResponse, AWSError>; 274 /** 275 * Lists geofence collections in your AWS account. 276 */ 277 listGeofenceCollections(callback?: (err: AWSError, data: Location.Types.ListGeofenceCollectionsResponse) => void): Request<Location.Types.ListGeofenceCollectionsResponse, AWSError>; 278 /** 279 * Lists geofences stored in a given geofence collection. 280 */ 281 listGeofences(params: Location.Types.ListGeofencesRequest, callback?: (err: AWSError, data: Location.Types.ListGeofencesResponse) => void): Request<Location.Types.ListGeofencesResponse, AWSError>; 282 /** 283 * Lists geofences stored in a given geofence collection. 284 */ 285 listGeofences(callback?: (err: AWSError, data: Location.Types.ListGeofencesResponse) => void): Request<Location.Types.ListGeofencesResponse, AWSError>; 286 /** 287 * Lists map resources in your AWS account. 288 */ 289 listMaps(params: Location.Types.ListMapsRequest, callback?: (err: AWSError, data: Location.Types.ListMapsResponse) => void): Request<Location.Types.ListMapsResponse, AWSError>; 290 /** 291 * Lists map resources in your AWS account. 292 */ 293 listMaps(callback?: (err: AWSError, data: Location.Types.ListMapsResponse) => void): Request<Location.Types.ListMapsResponse, AWSError>; 294 /** 295 * Lists place index resources in your AWS account. 296 */ 297 listPlaceIndexes(params: Location.Types.ListPlaceIndexesRequest, callback?: (err: AWSError, data: Location.Types.ListPlaceIndexesResponse) => void): Request<Location.Types.ListPlaceIndexesResponse, AWSError>; 298 /** 299 * Lists place index resources in your AWS account. 300 */ 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 a list of tags that are applied to the specified Amazon Location resource. 312 */ 313 listTagsForResource(params: Location.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Location.Types.ListTagsForResourceResponse) => void): Request<Location.Types.ListTagsForResourceResponse, AWSError>; 314 /** 315 * Returns a list of tags that are applied to the specified Amazon Location resource. 316 */ 317 listTagsForResource(callback?: (err: AWSError, data: Location.Types.ListTagsForResourceResponse) => void): Request<Location.Types.ListTagsForResourceResponse, AWSError>; 318 /** 319 * Lists geofence collections currently associated to the given tracker resource. 320 */ 321 listTrackerConsumers(params: Location.Types.ListTrackerConsumersRequest, callback?: (err: AWSError, data: Location.Types.ListTrackerConsumersResponse) => void): Request<Location.Types.ListTrackerConsumersResponse, AWSError>; 322 /** 323 * Lists geofence collections currently associated to the given tracker resource. 324 */ 325 listTrackerConsumers(callback?: (err: AWSError, data: Location.Types.ListTrackerConsumersResponse) => void): Request<Location.Types.ListTrackerConsumersResponse, AWSError>; 326 /** 327 * Lists tracker resources in your AWS account. 328 */ 329 listTrackers(params: Location.Types.ListTrackersRequest, callback?: (err: AWSError, data: Location.Types.ListTrackersResponse) => void): Request<Location.Types.ListTrackersResponse, AWSError>; 330 /** 331 * Lists tracker resources in your AWS account. 332 */ 333 listTrackers(callback?: (err: AWSError, data: Location.Types.ListTrackersResponse) => void): Request<Location.Types.ListTrackersResponse, AWSError>; 334 /** 335 * Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request. 336 */ 337 putGeofence(params: Location.Types.PutGeofenceRequest, callback?: (err: AWSError, data: Location.Types.PutGeofenceResponse) => void): Request<Location.Types.PutGeofenceResponse, AWSError>; 338 /** 339 * Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request. 340 */ 341 putGeofence(callback?: (err: AWSError, data: Location.Types.PutGeofenceResponse) => void): Request<Location.Types.PutGeofenceResponse, AWSError>; 342 /** 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. 344 */ 345 searchPlaceIndexForPosition(params: Location.Types.SearchPlaceIndexForPositionRequest, callback?: (err: AWSError, data: Location.Types.SearchPlaceIndexForPositionResponse) => void): Request<Location.Types.SearchPlaceIndexForPositionResponse, AWSError>; 346 /** 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. 348 */ 349 searchPlaceIndexForPosition(callback?: (err: AWSError, data: Location.Types.SearchPlaceIndexForPositionResponse) => void): Request<Location.Types.SearchPlaceIndexForPositionResponse, AWSError>; 350 /** 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. 352 */ 353 searchPlaceIndexForText(params: Location.Types.SearchPlaceIndexForTextRequest, callback?: (err: AWSError, data: Location.Types.SearchPlaceIndexForTextResponse) => void): Request<Location.Types.SearchPlaceIndexForTextResponse, AWSError>; 354 /** 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. 356 */ 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>You can use the <code>TagResource</code> operation 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's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 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>You can use the <code>TagResource</code> operation 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's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 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 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 resource. 372 */ 373 untagResource(callback?: (err: AWSError, data: Location.Types.UntagResourceResponse) => void): Request<Location.Types.UntagResourceResponse, AWSError>; 374 /** 375 * Updates the specified properties of a given geofence collection. 376 */ 377 updateGeofenceCollection(params: Location.Types.UpdateGeofenceCollectionRequest, callback?: (err: AWSError, data: Location.Types.UpdateGeofenceCollectionResponse) => void): Request<Location.Types.UpdateGeofenceCollectionResponse, AWSError>; 378 /** 379 * Updates the specified properties of a given geofence collection. 380 */ 381 updateGeofenceCollection(callback?: (err: AWSError, data: Location.Types.UpdateGeofenceCollectionResponse) => void): Request<Location.Types.UpdateGeofenceCollectionResponse, AWSError>; 382 /** 383 * Updates the specified properties of a given map resource. 384 */ 385 updateMap(params: Location.Types.UpdateMapRequest, callback?: (err: AWSError, data: Location.Types.UpdateMapResponse) => void): Request<Location.Types.UpdateMapResponse, AWSError>; 386 /** 387 * Updates the specified properties of a given map resource. 388 */ 389 updateMap(callback?: (err: AWSError, data: Location.Types.UpdateMapResponse) => void): Request<Location.Types.UpdateMapResponse, AWSError>; 390 /** 391 * Updates the specified properties of a given place index resource. 392 */ 393 updatePlaceIndex(params: Location.Types.UpdatePlaceIndexRequest, callback?: (err: AWSError, data: Location.Types.UpdatePlaceIndexResponse) => void): Request<Location.Types.UpdatePlaceIndexResponse, AWSError>; 394 /** 395 * Updates the specified properties of a given place index resource. 396 */ 397 updatePlaceIndex(callback?: (err: AWSError, data: Location.Types.UpdatePlaceIndexResponse) => void): Request<Location.Types.UpdatePlaceIndexResponse, AWSError>; 398 /** 399 * Updates the specified properties for a given route calculator resource. 400 */ 401 updateRouteCalculator(params: Location.Types.UpdateRouteCalculatorRequest, callback?: (err: AWSError, data: Location.Types.UpdateRouteCalculatorResponse) => void): Request<Location.Types.UpdateRouteCalculatorResponse, AWSError>; 402 /** 403 * Updates the specified properties for a given route calculator resource. 404 */ 405 updateRouteCalculator(callback?: (err: AWSError, data: Location.Types.UpdateRouteCalculatorResponse) => void): Request<Location.Types.UpdateRouteCalculatorResponse, AWSError>; 406 /** 407 * Updates the specified properties of a given tracker resource. 408 */ 409 updateTracker(params: Location.Types.UpdateTrackerRequest, callback?: (err: AWSError, data: Location.Types.UpdateTrackerResponse) => void): Request<Location.Types.UpdateTrackerResponse, AWSError>; 410 /** 411 * Updates the specified properties of a given tracker resource. 412 */ 413 updateTracker(callback?: (err: AWSError, data: Location.Types.UpdateTrackerResponse) => void): Request<Location.Types.UpdateTrackerResponse, AWSError>; 414 } 415 declare namespace Location { 416 export type Arn = string; 417 export type ArnList = Arn[]; 418 export interface AssociateTrackerConsumerRequest { 419 /** 420 * 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 421 */ 422 ConsumerArn: Arn; 423 /** 424 * The name of the tracker resource to be associated with a geofence collection. 425 */ 426 TrackerName: ResourceName; 427 } 428 export interface AssociateTrackerConsumerResponse { 429 } 430 export interface BatchDeleteDevicePositionHistoryError { 431 /** 432 * The ID of the device for this position. 433 */ 434 DeviceId: Id; 435 Error: BatchItemError; 436 } 437 export type BatchDeleteDevicePositionHistoryErrorList = BatchDeleteDevicePositionHistoryError[]; 438 export interface BatchDeleteDevicePositionHistoryRequest { 439 /** 440 * Devices whose position history you want to delete. For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2] 441 */ 442 DeviceIds: BatchDeleteDevicePositionHistoryRequestDeviceIdsList; 443 /** 444 * The name of the tracker resource to delete the device position history from. 445 */ 446 TrackerName: ResourceName; 447 } 448 export type BatchDeleteDevicePositionHistoryRequestDeviceIdsList = Id[]; 449 export interface BatchDeleteDevicePositionHistoryResponse { 450 /** 451 * Contains error details for each device history that failed to delete. 452 */ 453 Errors: BatchDeleteDevicePositionHistoryErrorList; 454 } 455 export interface BatchDeleteGeofenceError { 456 /** 457 * Contains details associated to the batch error. 458 */ 459 Error: BatchItemError; 460 /** 461 * The geofence associated with the error message. 462 */ 463 GeofenceId: Id; 464 } 465 export type BatchDeleteGeofenceErrorList = BatchDeleteGeofenceError[]; 466 export interface BatchDeleteGeofenceRequest { 467 /** 468 * The geofence collection storing the geofences to be deleted. 469 */ 470 CollectionName: ResourceName; 471 /** 472 * The batch of geofences to be deleted. 473 */ 474 GeofenceIds: BatchDeleteGeofenceRequestGeofenceIdsList; 475 } 476 export type BatchDeleteGeofenceRequestGeofenceIdsList = Id[]; 477 export interface BatchDeleteGeofenceResponse { 478 /** 479 * Contains error details for each geofence that failed to delete. 480 */ 481 Errors: BatchDeleteGeofenceErrorList; 482 } 483 export interface BatchEvaluateGeofencesError { 484 /** 485 * The device associated with the position evaluation error. 486 */ 487 DeviceId: Id; 488 /** 489 * Contains details associated to the batch error. 490 */ 491 Error: BatchItemError; 492 /** 493 * Specifies a timestamp for when the error occurred in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 494 */ 495 SampleTime: Timestamp; 496 } 497 export type BatchEvaluateGeofencesErrorList = BatchEvaluateGeofencesError[]; 498 export interface BatchEvaluateGeofencesRequest { 499 /** 500 * The geofence collection used in evaluating the position of devices against its geofences. 501 */ 502 CollectionName: ResourceName; 503 /** 504 * Contains device details for each device to be evaluated against the given geofence collection. 505 */ 506 DevicePositionUpdates: BatchEvaluateGeofencesRequestDevicePositionUpdatesList; 507 } 508 export type BatchEvaluateGeofencesRequestDevicePositionUpdatesList = DevicePositionUpdate[]; 509 export interface BatchEvaluateGeofencesResponse { 510 /** 511 * Contains error details for each device that failed to evaluate its position against the given geofence collection. 512 */ 513 Errors: BatchEvaluateGeofencesErrorList; 514 } 515 export interface BatchGetDevicePositionError { 516 /** 517 * The ID of the device that didn't return a position. 518 */ 519 DeviceId: Id; 520 /** 521 * Contains details related to the error code. 522 */ 523 Error: BatchItemError; 524 } 525 export type BatchGetDevicePositionErrorList = BatchGetDevicePositionError[]; 526 export interface BatchGetDevicePositionRequest { 527 /** 528 * Devices whose position you want to retrieve. For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2 529 */ 530 DeviceIds: BatchGetDevicePositionRequestDeviceIdsList; 531 /** 532 * The tracker resource retrieving the device position. 533 */ 534 TrackerName: BatchGetDevicePositionRequestTrackerNameString; 535 } 536 export type BatchGetDevicePositionRequestDeviceIdsList = Id[]; 537 export type BatchGetDevicePositionRequestTrackerNameString = string; 538 export interface BatchGetDevicePositionResponse { 539 /** 540 * Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled. 541 */ 542 DevicePositions: DevicePositionList; 543 /** 544 * Contains error details for each device that failed to send its position to the tracker resource. 545 */ 546 Errors: BatchGetDevicePositionErrorList; 547 } 548 export interface BatchItemError { 549 /** 550 * The error code associated with the batch request error. 551 */ 552 Code?: BatchItemErrorCode; 553 /** 554 * A message with the reason for the batch request error. 555 */ 556 Message?: String; 557 } 558 export type BatchItemErrorCode = "AccessDeniedError"|"ConflictError"|"InternalServerError"|"ResourceNotFoundError"|"ThrottlingError"|"ValidationError"|string; 559 export interface BatchPutGeofenceError { 560 /** 561 * Contains details associated to the batch error. 562 */ 563 Error: BatchItemError; 564 /** 565 * The geofence associated with the error message. 566 */ 567 GeofenceId: Id; 568 } 569 export type BatchPutGeofenceErrorList = BatchPutGeofenceError[]; 570 export interface BatchPutGeofenceRequest { 571 /** 572 * The geofence collection storing the geofences. 573 */ 574 CollectionName: ResourceName; 575 /** 576 * The batch of geofences to be stored in a geofence collection. 577 */ 578 Entries: BatchPutGeofenceRequestEntriesList; 579 } 580 export type BatchPutGeofenceRequestEntriesList = BatchPutGeofenceRequestEntry[]; 581 export interface BatchPutGeofenceRequestEntry { 582 /** 583 * The identifier for the geofence to be stored in a given geofence collection. 584 */ 585 GeofenceId: Id; 586 /** 587 * Contains the polygon details to specify the position of the geofence. Each geofence polygon can have a maximum of 1,000 vertices. 588 */ 589 Geometry: GeofenceGeometry; 590 } 591 export interface BatchPutGeofenceResponse { 592 /** 593 * Contains additional error details for each geofence that failed to be stored in a geofence collection. 594 */ 595 Errors: BatchPutGeofenceErrorList; 596 /** 597 * Contains each geofence that was successfully stored in a geofence collection. 598 */ 599 Successes: BatchPutGeofenceSuccessList; 600 } 601 export interface BatchPutGeofenceSuccess { 602 /** 603 * The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 604 */ 605 CreateTime: Timestamp; 606 /** 607 * The geofence successfully stored in a geofence collection. 608 */ 609 GeofenceId: Id; 610 /** 611 * The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 612 */ 613 UpdateTime: Timestamp; 614 } 615 export type BatchPutGeofenceSuccessList = BatchPutGeofenceSuccess[]; 616 export interface BatchUpdateDevicePositionError { 617 /** 618 * The device associated with the failed location update. 619 */ 620 DeviceId: Id; 621 /** 622 * Contains details related to the error code such as the error code and error message. 623 */ 624 Error: BatchItemError; 625 /** 626 * The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 627 */ 628 SampleTime: Timestamp; 629 } 630 export type BatchUpdateDevicePositionErrorList = BatchUpdateDevicePositionError[]; 631 export interface BatchUpdateDevicePositionRequest { 632 /** 633 * The name of the tracker resource to update. 634 */ 635 TrackerName: ResourceName; 636 /** 637 * Contains the position update details for each device. 638 */ 639 Updates: BatchUpdateDevicePositionRequestUpdatesList; 640 } 641 export type BatchUpdateDevicePositionRequestUpdatesList = DevicePositionUpdate[]; 642 export interface BatchUpdateDevicePositionResponse { 643 /** 644 * Contains error details for each device that failed to update its position. 645 */ 646 Errors: BatchUpdateDevicePositionErrorList; 647 } 648 export type _Blob = Buffer|Uint8Array|Blob|string; 649 export type Boolean = boolean; 650 export type BoundingBox = Double[]; 651 export interface CalculateRouteCarModeOptions { 652 /** 653 * Avoids ferries when calculating routes. Default Value: false Valid Values: false | true 654 */ 655 AvoidFerries?: Boolean; 656 /** 657 * Avoids tolls when calculating routes. Default Value: false Valid Values: false | true 658 */ 659 AvoidTolls?: Boolean; 660 } 661 export interface CalculateRouteRequest { 662 /** 663 * The name of the route calculator resource that you want to use to calculate a route. 664 */ 665 CalculatorName: ResourceName; 666 /** 667 * Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls. Requirements: TravelMode must be specified as Car. 668 */ 669 CarModeOptions?: CalculateRouteCarModeOptions; 670 /** 671 * 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 672 */ 673 DepartNow?: Boolean; 674 /** 675 * 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] 676 */ 677 DeparturePosition: Position; 678 /** 679 * 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 680 */ 681 DepartureTime?: Timestamp; 682 /** 683 * 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] 684 */ 685 DestinationPosition: Position; 686 /** 687 * Set the unit system to specify the distance. Default Value: Kilometers 688 */ 689 DistanceUnit?: DistanceUnit; 690 /** 691 * Set to include the geometry details in the result for each path between a pair of positions. Default Value: false Valid Values: false | true 692 */ 693 IncludeLegGeometry?: Boolean; 694 /** 695 * 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 696 */ 697 TravelMode?: TravelMode; 698 /** 699 * 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. 700 */ 701 TruckModeOptions?: CalculateRouteTruckModeOptions; 702 /** 703 * 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] 704 */ 705 WaypointPositions?: CalculateRouteRequestWaypointPositionsList; 706 } 707 export type CalculateRouteRequestWaypointPositionsList = Position[]; 708 export interface CalculateRouteResponse { 709 /** 710 * 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 fewer 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. 711 */ 712 Legs: LegList; 713 /** 714 * Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds. 715 */ 716 Summary: CalculateRouteSummary; 717 } 718 export interface CalculateRouteSummary { 719 /** 720 * 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. 721 */ 722 DataSource: String; 723 /** 724 * 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. 725 */ 726 Distance: CalculateRouteSummaryDistanceDouble; 727 /** 728 * The unit of measurement for the distance. 729 */ 730 DistanceUnit: DistanceUnit; 731 /** 732 * The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route. 733 */ 734 DurationSeconds: CalculateRouteSummaryDurationSecondsDouble; 735 /** 736 * 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. 737 */ 738 RouteBBox: BoundingBox; 739 } 740 export type CalculateRouteSummaryDistanceDouble = number; 741 export type CalculateRouteSummaryDurationSecondsDouble = number; 742 export interface CalculateRouteTruckModeOptions { 743 /** 744 * Avoids ferries when calculating routes. Default Value: false Valid Values: false | true 745 */ 746 AvoidFerries?: Boolean; 747 /** 748 * Avoids ferries when calculating routes. Default Value: false Valid Values: false | true 749 */ 750 AvoidTolls?: Boolean; 751 /** 752 * 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. 753 */ 754 Dimensions?: TruckDimensions; 755 /** 756 * 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. 757 */ 758 Weight?: TruckWeight; 759 } 760 export type CountryCode = string; 761 export type CountryCodeList = CountryCode[]; 762 export interface CreateGeofenceCollectionRequest { 763 /** 764 * 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. 765 */ 766 CollectionName: ResourceName; 767 /** 768 * An optional description for the geofence collection. 769 */ 770 Description?: ResourceDescription; 771 /** 772 * A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. 773 */ 774 KmsKeyId?: KmsKeyId; 775 /** 776 * 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. 777 */ 778 PricingPlan: PricingPlan; 779 /** 780 * 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 781 */ 782 PricingPlanDataSource?: String; 783 /** 784 * 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: + - = . _ : / @. 785 */ 786 Tags?: TagMap; 787 } 788 export interface CreateGeofenceCollectionResponse { 789 /** 790 * 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 791 */ 792 CollectionArn: Arn; 793 /** 794 * The name for the geofence collection. 795 */ 796 CollectionName: ResourceName; 797 /** 798 * The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 799 */ 800 CreateTime: Timestamp; 801 } 802 export interface CreateMapRequest { 803 /** 804 * Specifies the map style selected from an available data provider. 805 */ 806 Configuration: MapConfiguration; 807 /** 808 * An optional description for the map resource. 809 */ 810 Description?: ResourceDescription; 811 /** 812 * The name for the map resource. Requirements: Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique map resource name. No spaces allowed. For example, ExampleMap. 813 */ 814 MapName: ResourceName; 815 /** 816 * 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. 817 */ 818 PricingPlan: PricingPlan; 819 /** 820 * 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: + - = . _ : / @. 821 */ 822 Tags?: TagMap; 823 } 824 export interface CreateMapResponse { 825 /** 826 * The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 827 */ 828 CreateTime: Timestamp; 829 /** 830 * The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:maps/ExampleMap 831 */ 832 MapArn: Arn; 833 /** 834 * The name of the map resource. 835 */ 836 MapName: ResourceName; 837 } 838 export interface CreatePlaceIndexRequest { 839 /** 840 * Specifies the data provider of geospatial data. This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error. Valid values include: Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage. Here – For additional information about HERE Technologies's coverage in your region of interest, see HERE details on goecoding coverage. Place index resources using HERE Technologies as a data provider can't store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service. For additional information , see Data providers on the Amazon Location Service Developer Guide. 841 */ 842 DataSource: String; 843 /** 844 * Specifies the data storage option requesting Places. 845 */ 846 DataSourceConfiguration?: DataSourceConfiguration; 847 /** 848 * The optional description for the place index resource. 849 */ 850 Description?: ResourceDescription; 851 /** 852 * 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. 853 */ 854 IndexName: ResourceName; 855 /** 856 * 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. 857 */ 858 PricingPlan: PricingPlan; 859 /** 860 * 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: + - = . _ : / @. 861 */ 862 Tags?: TagMap; 863 } 864 export interface CreatePlaceIndexResponse { 865 /** 866 * The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 867 */ 868 CreateTime: Timestamp; 869 /** 870 * The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex 871 */ 872 IndexArn: Arn; 873 /** 874 * The name for the place index resource. 875 */ 876 IndexName: ResourceName; 877 } 878 export interface CreateRouteCalculatorRequest { 879 /** 880 * 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. 881 */ 882 CalculatorName: ResourceName; 883 /** 884 * 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 include: Esri – For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage. Here – For additional information about HERE Technologies's coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage. For additional information , see Data providers on the Amazon Location Service Developer Guide. 885 */ 886 DataSource: String; 887 /** 888 * The optional description for the route calculator resource. 889 */ 890 Description?: ResourceDescription; 891 /** 892 * Specifies the pricing plan for your route calculator resource. For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing. 893 */ 894 PricingPlan: PricingPlan; 895 /** 896 * 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: + - = . _ : / @. 897 */ 898 Tags?: TagMap; 899 } 900 export interface CreateRouteCalculatorResponse { 901 /** 902 * 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 903 */ 904 CalculatorArn: Arn; 905 /** 906 * The name of the route calculator resource. For example, ExampleRouteCalculator. 907 */ 908 CalculatorName: ResourceName; 909 /** 910 * 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 911 */ 912 CreateTime: Timestamp; 913 } 914 export interface CreateTrackerRequest { 915 /** 916 * An optional description for the tracker resource. 917 */ 918 Description?: ResourceDescription; 919 /** 920 * A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. 921 */ 922 KmsKeyId?: KmsKeyId; 923 /** 924 * 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. 925 */ 926 PricingPlan: PricingPlan; 927 /** 928 * 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 929 */ 930 PricingPlanDataSource?: String; 931 /** 932 * 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: + - = . _ : / @. 933 */ 934 Tags?: TagMap; 935 /** 936 * 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. 937 */ 938 TrackerName: ResourceName; 939 } 940 export interface CreateTrackerResponse { 941 /** 942 * The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 943 */ 944 CreateTime: Timestamp; 945 /** 946 * 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 947 */ 948 TrackerArn: Arn; 949 /** 950 * The name of the tracker resource. 951 */ 952 TrackerName: ResourceName; 953 } 954 export interface DataSourceConfiguration { 955 /** 956 * 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. Default value: SingleUse 957 */ 958 IntendedUse?: IntendedUse; 959 } 960 export interface DeleteGeofenceCollectionRequest { 961 /** 962 * The name of the geofence collection to be deleted. 963 */ 964 CollectionName: ResourceName; 965 } 966 export interface DeleteGeofenceCollectionResponse { 967 } 968 export interface DeleteMapRequest { 969 /** 970 * The name of the map resource to be deleted. 971 */ 972 MapName: ResourceName; 973 } 974 export interface DeleteMapResponse { 975 } 976 export interface DeletePlaceIndexRequest { 977 /** 978 * The name of the place index resource to be deleted. 979 */ 980 IndexName: ResourceName; 981 } 982 export interface DeletePlaceIndexResponse { 983 } 984 export interface DeleteRouteCalculatorRequest { 985 /** 986 * The name of the route calculator resource to be deleted. 987 */ 988 CalculatorName: ResourceName; 989 } 990 export interface DeleteRouteCalculatorResponse { 991 } 992 export interface DeleteTrackerRequest { 993 /** 994 * The name of the tracker resource to be deleted. 995 */ 996 TrackerName: ResourceName; 997 } 998 export interface DeleteTrackerResponse { 999 } 1000 export interface DescribeGeofenceCollectionRequest { 1001 /** 1002 * The name of the geofence collection. 1003 */ 1004 CollectionName: ResourceName; 1005 } 1006 export interface DescribeGeofenceCollectionResponse { 1007 /** 1008 * 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 1009 */ 1010 CollectionArn: Arn; 1011 /** 1012 * The name of the geofence collection. 1013 */ 1014 CollectionName: ResourceName; 1015 /** 1016 * The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1017 */ 1018 CreateTime: Timestamp; 1019 /** 1020 * The optional description for the geofence collection. 1021 */ 1022 Description: ResourceDescription; 1023 /** 1024 * A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource 1025 */ 1026 KmsKeyId?: KmsKeyId; 1027 /** 1028 * 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. 1029 */ 1030 PricingPlan: PricingPlan; 1031 /** 1032 * The specified data provider for the geofence collection. 1033 */ 1034 PricingPlanDataSource?: String; 1035 /** 1036 * Displays the key, value pairs of tags associated with this resource. 1037 */ 1038 Tags?: TagMap; 1039 /** 1040 * The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1041 */ 1042 UpdateTime: Timestamp; 1043 } 1044 export interface DescribeMapRequest { 1045 /** 1046 * The name of the map resource. 1047 */ 1048 MapName: ResourceName; 1049 } 1050 export interface DescribeMapResponse { 1051 /** 1052 * Specifies the map tile style selected from a partner data provider. 1053 */ 1054 Configuration: MapConfiguration; 1055 /** 1056 * The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1057 */ 1058 CreateTime: Timestamp; 1059 /** 1060 * Specifies the data provider for the associated map tiles. 1061 */ 1062 DataSource: String; 1063 /** 1064 * The optional description for the map resource. 1065 */ 1066 Description: ResourceDescription; 1067 /** 1068 * The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS. Format example: arn:aws:geo:region:account-id:maps/ExampleMap 1069 */ 1070 MapArn: Arn; 1071 /** 1072 * The map style selected from an available provider. 1073 */ 1074 MapName: ResourceName; 1075 /** 1076 * 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> 1077 */ 1078 PricingPlan: PricingPlan; 1079 /** 1080 * Tags associated with the map resource. 1081 */ 1082 Tags?: TagMap; 1083 /** 1084 * The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1085 */ 1086 UpdateTime: Timestamp; 1087 } 1088 export interface DescribePlaceIndexRequest { 1089 /** 1090 * The name of the place index resource. 1091 */ 1092 IndexName: ResourceName; 1093 } 1094 export interface DescribePlaceIndexResponse { 1095 /** 1096 * The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1097 */ 1098 CreateTime: Timestamp; 1099 /** 1100 * 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. 1101 */ 1102 DataSource: String; 1103 /** 1104 * The specified data storage option for requesting Places. 1105 */ 1106 DataSourceConfiguration: DataSourceConfiguration; 1107 /** 1108 * The optional description for the place index resource. 1109 */ 1110 Description: ResourceDescription; 1111 /** 1112 * The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex 1113 */ 1114 IndexArn: Arn; 1115 /** 1116 * The name of the place index resource being described. 1117 */ 1118 IndexName: ResourceName; 1119 /** 1120 * 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. 1121 */ 1122 PricingPlan: PricingPlan; 1123 /** 1124 * Tags associated with place index resource. 1125 */ 1126 Tags?: TagMap; 1127 /** 1128 * The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1129 */ 1130 UpdateTime: Timestamp; 1131 } 1132 export interface DescribeRouteCalculatorRequest { 1133 /** 1134 * The name of the route calculator resource. 1135 */ 1136 CalculatorName: ResourceName; 1137 } 1138 export interface DescribeRouteCalculatorResponse { 1139 /** 1140 * 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 1141 */ 1142 CalculatorArn: Arn; 1143 /** 1144 * The name of the route calculator resource being described. 1145 */ 1146 CalculatorName: ResourceName; 1147 /** 1148 * 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 1149 */ 1150 CreateTime: Timestamp; 1151 /** 1152 * 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. 1153 */ 1154 DataSource: String; 1155 /** 1156 * The optional description of the route calculator resource. 1157 */ 1158 Description: ResourceDescription; 1159 /** 1160 * 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. 1161 */ 1162 PricingPlan: PricingPlan; 1163 /** 1164 * Tags associated with route calculator resource. 1165 */ 1166 Tags?: TagMap; 1167 /** 1168 * 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 1169 */ 1170 UpdateTime: Timestamp; 1171 } 1172 export interface DescribeTrackerRequest { 1173 /** 1174 * The name of the tracker resource. 1175 */ 1176 TrackerName: ResourceName; 1177 } 1178 export interface DescribeTrackerResponse { 1179 /** 1180 * The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1181 */ 1182 CreateTime: Timestamp; 1183 /** 1184 * The optional description for the tracker resource. 1185 */ 1186 Description: ResourceDescription; 1187 /** 1188 * A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource. 1189 */ 1190 KmsKeyId?: KmsKeyId; 1191 /** 1192 * 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. 1193 */ 1194 PricingPlan: PricingPlan; 1195 /** 1196 * The specified data provider for the tracker resource. 1197 */ 1198 PricingPlanDataSource?: String; 1199 /** 1200 * The tags associated with the tracker resource. 1201 */ 1202 Tags?: TagMap; 1203 /** 1204 * 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 1205 */ 1206 TrackerArn: Arn; 1207 /** 1208 * The name of the tracker resource. 1209 */ 1210 TrackerName: ResourceName; 1211 /** 1212 * The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1213 */ 1214 UpdateTime: Timestamp; 1215 } 1216 export interface DevicePosition { 1217 /** 1218 * The device whose position you retrieved. 1219 */ 1220 DeviceId?: Id; 1221 /** 1222 * The last known device position. 1223 */ 1224 Position: Position; 1225 /** 1226 * The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1227 */ 1228 ReceivedTime: Timestamp; 1229 /** 1230 * The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1231 */ 1232 SampleTime: Timestamp; 1233 } 1234 export type DevicePositionList = DevicePosition[]; 1235 export interface DevicePositionUpdate { 1236 /** 1237 * The device associated to the position update. 1238 */ 1239 DeviceId: Id; 1240 /** 1241 * The latest device position defined in WGS 84 format: [X or longitude, Y or latitude]. 1242 */ 1243 Position: Position; 1244 /** 1245 * The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1246 */ 1247 SampleTime: Timestamp; 1248 } 1249 export type DimensionUnit = "Meters"|"Feet"|string; 1250 export interface DisassociateTrackerConsumerRequest { 1251 /** 1252 * 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 1253 */ 1254 ConsumerArn: Arn; 1255 /** 1256 * The name of the tracker resource to be dissociated from the consumer. 1257 */ 1258 TrackerName: ResourceName; 1259 } 1260 export interface DisassociateTrackerConsumerResponse { 1261 } 1262 export type DistanceUnit = "Kilometers"|"Miles"|string; 1263 export type Double = number; 1264 export interface GeofenceGeometry { 1265 /** 1266 * An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude]. The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior. 1267 */ 1268 Polygon?: LinearRings; 1269 } 1270 export interface GetDevicePositionHistoryRequest { 1271 /** 1272 * The device whose position history you want to retrieve. 1273 */ 1274 DeviceId: Id; 1275 /** 1276 * Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made. Requirement: The time specified for EndTimeExclusive must be after the time for StartTimeInclusive. 1277 */ 1278 EndTimeExclusive?: Timestamp; 1279 /** 1280 * 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 1281 */ 1282 NextToken?: Token; 1283 /** 1284 * Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made. Requirement: The time specified for StartTimeInclusive must be before EndTimeExclusive. 1285 */ 1286 StartTimeInclusive?: Timestamp; 1287 /** 1288 * The tracker resource receiving the request for the device position history. 1289 */ 1290 TrackerName: ResourceName; 1291 } 1292 export interface GetDevicePositionHistoryResponse { 1293 /** 1294 * Contains the position history details for the requested device. 1295 */ 1296 DevicePositions: DevicePositionList; 1297 /** 1298 * 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. 1299 */ 1300 NextToken?: Token; 1301 } 1302 export interface GetDevicePositionRequest { 1303 /** 1304 * The device whose position you want to retrieve. 1305 */ 1306 DeviceId: Id; 1307 /** 1308 * The tracker resource receiving the position update. 1309 */ 1310 TrackerName: ResourceName; 1311 } 1312 export interface GetDevicePositionResponse { 1313 /** 1314 * The device whose position you retrieved. 1315 */ 1316 DeviceId?: Id; 1317 /** 1318 * The last known device position. 1319 */ 1320 Position: Position; 1321 /** 1322 * The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1323 */ 1324 ReceivedTime: Timestamp; 1325 /** 1326 * The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1327 */ 1328 SampleTime: Timestamp; 1329 } 1330 export interface GetGeofenceRequest { 1331 /** 1332 * The geofence collection storing the target geofence. 1333 */ 1334 CollectionName: ResourceName; 1335 /** 1336 * The geofence you're retrieving details for. 1337 */ 1338 GeofenceId: Id; 1339 } 1340 export interface GetGeofenceResponse { 1341 /** 1342 * The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1343 */ 1344 CreateTime: Timestamp; 1345 /** 1346 * The geofence identifier. 1347 */ 1348 GeofenceId: Id; 1349 /** 1350 * Contains the geofence geometry details describing a polygon. 1351 */ 1352 Geometry: GeofenceGeometry; 1353 /** 1354 * Identifies the state of the geofence. A geofence will hold one of the following states: ACTIVE — The geofence has been indexed by the system. PENDING — The geofence is being processed by the system. FAILED — The geofence failed to be indexed by the system. DELETED — The geofence has been deleted from the system index. DELETING — The geofence is being deleted from the system index. 1355 */ 1356 Status: String; 1357 /** 1358 * The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1359 */ 1360 UpdateTime: Timestamp; 1361 } 1362 export interface GetMapGlyphsRequest { 1363 /** 1364 * A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode. Valid fonts for Esri styles: VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold Valid fonts for HERE Technologies styles: VectorHereBerlin – Fira GO Regular | Fira GO Bold 1365 */ 1366 FontStack: String; 1367 /** 1368 * 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. 1369 */ 1370 FontUnicodeRange: GetMapGlyphsRequestFontUnicodeRangeString; 1371 /** 1372 * The map resource associated with the glyph file. 1373 */ 1374 MapName: ResourceName; 1375 } 1376 export type GetMapGlyphsRequestFontUnicodeRangeString = string; 1377 export interface GetMapGlyphsResponse { 1378 /** 1379 * The blob's content type. 1380 */ 1381 Blob?: _Blob; 1382 /** 1383 * The map glyph content type. For example, application/octet-stream. 1384 */ 1385 ContentType?: String; 1386 } 1387 export interface GetMapSpritesRequest { 1388 /** 1389 * The name of the sprite file. Use the following file names for the sprite sheet: sprites.png sprites@2x.png for high pixel density displays For the JSON document contain image offsets. Use the following file names: sprites.json sprites@2x.json for high pixel density displays 1390 */ 1391 FileName: GetMapSpritesRequestFileNameString; 1392 /** 1393 * The map resource associated with the sprite file. 1394 */ 1395 MapName: ResourceName; 1396 } 1397 export type GetMapSpritesRequestFileNameString = string; 1398 export interface GetMapSpritesResponse { 1399 /** 1400 * Contains the body of the sprite sheet or JSON offset file. 1401 */ 1402 Blob?: _Blob; 1403 /** 1404 * The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json. 1405 */ 1406 ContentType?: String; 1407 } 1408 export interface GetMapStyleDescriptorRequest { 1409 /** 1410 * The map resource to retrieve the style descriptor from. 1411 */ 1412 MapName: ResourceName; 1413 } 1414 export interface GetMapStyleDescriptorResponse { 1415 /** 1416 * Contains the body of the style descriptor. 1417 */ 1418 Blob?: _Blob; 1419 /** 1420 * The style descriptor's content type. For example, application/json. 1421 */ 1422 ContentType?: String; 1423 } 1424 export interface GetMapTileRequest { 1425 /** 1426 * The map resource to retrieve the map tiles from. 1427 */ 1428 MapName: ResourceName; 1429 /** 1430 * The X axis value for the map tile. 1431 */ 1432 X: GetMapTileRequestXString; 1433 /** 1434 * The Y axis value for the map tile. 1435 */ 1436 Y: GetMapTileRequestYString; 1437 /** 1438 * The zoom value for the map tile. 1439 */ 1440 Z: GetMapTileRequestZString; 1441 } 1442 export type GetMapTileRequestXString = string; 1443 export type GetMapTileRequestYString = string; 1444 export type GetMapTileRequestZString = string; 1445 export interface GetMapTileResponse { 1446 /** 1447 * Contains Mapbox Vector Tile (MVT) data. 1448 */ 1449 Blob?: _Blob; 1450 /** 1451 * The map tile's content type. For example, application/vnd.mapbox-vector-tile. 1452 */ 1453 ContentType?: String; 1454 } 1455 export type Id = string; 1456 export type IntendedUse = "SingleUse"|"Storage"|string; 1457 export type KmsKeyId = string; 1458 export interface Leg { 1459 /** 1460 * 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. 1461 */ 1462 Distance: LegDistanceDouble; 1463 /** 1464 * 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. 1465 */ 1466 DurationSeconds: LegDurationSecondsDouble; 1467 /** 1468 * 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. 1469 */ 1470 EndPosition: Position; 1471 /** 1472 * Contains the calculated route's path as a linestring geometry. 1473 */ 1474 Geometry?: LegGeometry; 1475 /** 1476 * 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. 1477 */ 1478 StartPosition: Position; 1479 /** 1480 * 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. 1481 */ 1482 Steps: StepList; 1483 } 1484 export type LegDistanceDouble = number; 1485 export type LegDurationSecondsDouble = number; 1486 export interface LegGeometry { 1487 /** 1488 * 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]] 1489 */ 1490 LineString?: LineString; 1491 } 1492 export type LegList = Leg[]; 1493 export type LineString = Position[]; 1494 export type LinearRing = Position[]; 1495 export type LinearRings = LinearRing[]; 1496 export interface ListDevicePositionsRequest { 1497 /** 1498 * An optional limit for the number of entries returned in a single call. Default value: 100 1499 */ 1500 MaxResults?: ListDevicePositionsRequestMaxResultsInteger; 1501 /** 1502 * 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 1503 */ 1504 NextToken?: Token; 1505 /** 1506 * The tracker resource containing the requested devices. 1507 */ 1508 TrackerName: ResourceName; 1509 } 1510 export type ListDevicePositionsRequestMaxResultsInteger = number; 1511 export interface ListDevicePositionsResponse { 1512 /** 1513 * 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. 1514 */ 1515 Entries: ListDevicePositionsResponseEntryList; 1516 /** 1517 * 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. 1518 */ 1519 NextToken?: Token; 1520 } 1521 export interface ListDevicePositionsResponseEntry { 1522 /** 1523 * The ID of the device for this position. 1524 */ 1525 DeviceId: Id; 1526 /** 1527 * The last known device position. Empty if no positions currently stored. 1528 */ 1529 Position: Position; 1530 /** 1531 * The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1532 */ 1533 SampleTime: Timestamp; 1534 } 1535 export type ListDevicePositionsResponseEntryList = ListDevicePositionsResponseEntry[]; 1536 export interface ListGeofenceCollectionsRequest { 1537 /** 1538 * An optional limit for the number of resources returned in a single call. Default value: 100 1539 */ 1540 MaxResults?: ListGeofenceCollectionsRequestMaxResultsInteger; 1541 /** 1542 * 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 1543 */ 1544 NextToken?: Token; 1545 } 1546 export type ListGeofenceCollectionsRequestMaxResultsInteger = number; 1547 export interface ListGeofenceCollectionsResponse { 1548 /** 1549 * Lists the geofence collections that exist in your AWS account. 1550 */ 1551 Entries: ListGeofenceCollectionsResponseEntryList; 1552 /** 1553 * 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. 1554 */ 1555 NextToken?: Token; 1556 } 1557 export interface ListGeofenceCollectionsResponseEntry { 1558 /** 1559 * The name of the geofence collection. 1560 */ 1561 CollectionName: ResourceName; 1562 /** 1563 * The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1564 */ 1565 CreateTime: Timestamp; 1566 /** 1567 * The description for the geofence collection 1568 */ 1569 Description: ResourceDescription; 1570 /** 1571 * The pricing plan for the specified geofence collection. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page. 1572 */ 1573 PricingPlan: PricingPlan; 1574 /** 1575 * The specified data provider for the geofence collection. 1576 */ 1577 PricingPlanDataSource?: String; 1578 /** 1579 * Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1580 */ 1581 UpdateTime: Timestamp; 1582 } 1583 export type ListGeofenceCollectionsResponseEntryList = ListGeofenceCollectionsResponseEntry[]; 1584 export interface ListGeofenceResponseEntry { 1585 /** 1586 * The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1587 */ 1588 CreateTime: Timestamp; 1589 /** 1590 * The geofence identifier. 1591 */ 1592 GeofenceId: Id; 1593 /** 1594 * Contains the geofence geometry details describing a polygon. 1595 */ 1596 Geometry: GeofenceGeometry; 1597 /** 1598 * Identifies the state of the geofence. A geofence will hold one of the following states: ACTIVE — The geofence has been indexed by the system. PENDING — The geofence is being processed by the system. FAILED — The geofence failed to be indexed by the system. DELETED — The geofence has been deleted from the system index. DELETING — The geofence is being deleted from the system index. 1599 */ 1600 Status: String; 1601 /** 1602 * The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1603 */ 1604 UpdateTime: Timestamp; 1605 } 1606 export type ListGeofenceResponseEntryList = ListGeofenceResponseEntry[]; 1607 export interface ListGeofencesRequest { 1608 /** 1609 * The name of the geofence collection storing the list of geofences. 1610 */ 1611 CollectionName: ResourceName; 1612 /** 1613 * 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 1614 */ 1615 NextToken?: Token; 1616 } 1617 export interface ListGeofencesResponse { 1618 /** 1619 * Contains a list of geofences stored in the geofence collection. 1620 */ 1621 Entries: ListGeofenceResponseEntryList; 1622 /** 1623 * 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. 1624 */ 1625 NextToken?: Token; 1626 } 1627 export interface ListMapsRequest { 1628 /** 1629 * An optional limit for the number of resources returned in a single call. Default value: 100 1630 */ 1631 MaxResults?: ListMapsRequestMaxResultsInteger; 1632 /** 1633 * 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 1634 */ 1635 NextToken?: Token; 1636 } 1637 export type ListMapsRequestMaxResultsInteger = number; 1638 export interface ListMapsResponse { 1639 /** 1640 * Contains a list of maps in your AWS account 1641 */ 1642 Entries: ListMapsResponseEntryList; 1643 /** 1644 * 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. 1645 */ 1646 NextToken?: Token; 1647 } 1648 export interface ListMapsResponseEntry { 1649 /** 1650 * The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1651 */ 1652 CreateTime: Timestamp; 1653 /** 1654 * Specifies the data provider for the associated map tiles. 1655 */ 1656 DataSource: String; 1657 /** 1658 * The description for the map resource. 1659 */ 1660 Description: ResourceDescription; 1661 /** 1662 * The name of the associated map resource. 1663 */ 1664 MapName: ResourceName; 1665 /** 1666 * The pricing plan for the specified map resource. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page. 1667 */ 1668 PricingPlan: PricingPlan; 1669 /** 1670 * The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1671 */ 1672 UpdateTime: Timestamp; 1673 } 1674 export type ListMapsResponseEntryList = ListMapsResponseEntry[]; 1675 export interface ListPlaceIndexesRequest { 1676 /** 1677 * An optional limit for the maximum number of results returned in a single call. Default value: 100 1678 */ 1679 MaxResults?: ListPlaceIndexesRequestMaxResultsInteger; 1680 /** 1681 * 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 1682 */ 1683 NextToken?: Token; 1684 } 1685 export type ListPlaceIndexesRequestMaxResultsInteger = number; 1686 export interface ListPlaceIndexesResponse { 1687 /** 1688 * Lists the place index resources that exist in your AWS account 1689 */ 1690 Entries: ListPlaceIndexesResponseEntryList; 1691 /** 1692 * 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. 1693 */ 1694 NextToken?: Token; 1695 } 1696 export interface ListPlaceIndexesResponseEntry { 1697 /** 1698 * The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1699 */ 1700 CreateTime: Timestamp; 1701 /** 1702 * 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. 1703 */ 1704 DataSource: String; 1705 /** 1706 * The optional description for the place index resource. 1707 */ 1708 Description: ResourceDescription; 1709 /** 1710 * The name of the place index resource. 1711 */ 1712 IndexName: ResourceName; 1713 /** 1714 * 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. 1715 */ 1716 PricingPlan: PricingPlan; 1717 /** 1718 * The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1719 */ 1720 UpdateTime: Timestamp; 1721 } 1722 export type ListPlaceIndexesResponseEntryList = ListPlaceIndexesResponseEntry[]; 1723 export interface ListRouteCalculatorsRequest { 1724 /** 1725 * An optional maximum number of results returned in a single call. Default Value: 100 1726 */ 1727 MaxResults?: ListRouteCalculatorsRequestMaxResultsInteger; 1728 /** 1729 * 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 1730 */ 1731 NextToken?: Token; 1732 } 1733 export type ListRouteCalculatorsRequestMaxResultsInteger = number; 1734 export interface ListRouteCalculatorsResponse { 1735 /** 1736 * Lists the route calculator resources that exist in your AWS account 1737 */ 1738 Entries: ListRouteCalculatorsResponseEntryList; 1739 /** 1740 * 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. 1741 */ 1742 NextToken?: Token; 1743 } 1744 export interface ListRouteCalculatorsResponseEntry { 1745 /** 1746 * The name of the route calculator resource. 1747 */ 1748 CalculatorName: ResourceName; 1749 /** 1750 * 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 1751 */ 1752 CreateTime: Timestamp; 1753 /** 1754 * 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. 1755 */ 1756 DataSource: String; 1757 /** 1758 * The optional description of the route calculator resource. 1759 */ 1760 Description: ResourceDescription; 1761 /** 1762 * The pricing plan for the specified route calculator resource. For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing. 1763 */ 1764 PricingPlan: PricingPlan; 1765 /** 1766 * 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 1767 */ 1768 UpdateTime: Timestamp; 1769 } 1770 export type ListRouteCalculatorsResponseEntryList = ListRouteCalculatorsResponseEntry[]; 1771 export interface ListTagsForResourceRequest { 1772 /** 1773 * The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource 1774 */ 1775 ResourceArn: Arn; 1776 } 1777 export interface ListTagsForResourceResponse { 1778 /** 1779 * Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: "TagKey" : "TagValue". Format example: {"tag1" : "value1", "tag2" : "value2"} 1780 */ 1781 Tags?: TagMap; 1782 } 1783 export interface ListTrackerConsumersRequest { 1784 /** 1785 * An optional limit for the number of resources returned in a single call. Default value: 100 1786 */ 1787 MaxResults?: ListTrackerConsumersRequestMaxResultsInteger; 1788 /** 1789 * 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 1790 */ 1791 NextToken?: Token; 1792 /** 1793 * The tracker resource whose associated geofence collections you want to list. 1794 */ 1795 TrackerName: ResourceName; 1796 } 1797 export type ListTrackerConsumersRequestMaxResultsInteger = number; 1798 export interface ListTrackerConsumersResponse { 1799 /** 1800 * Contains the list of geofence collection ARNs associated to the tracker resource. 1801 */ 1802 ConsumerArns: ArnList; 1803 /** 1804 * 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. 1805 */ 1806 NextToken?: Token; 1807 } 1808 export interface ListTrackersRequest { 1809 /** 1810 * An optional limit for the number of resources returned in a single call. Default value: 100 1811 */ 1812 MaxResults?: ListTrackersRequestMaxResultsInteger; 1813 /** 1814 * 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 1815 */ 1816 NextToken?: Token; 1817 } 1818 export type ListTrackersRequestMaxResultsInteger = number; 1819 export interface ListTrackersResponse { 1820 /** 1821 * Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated. 1822 */ 1823 Entries: ListTrackersResponseEntryList; 1824 /** 1825 * 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. 1826 */ 1827 NextToken?: Token; 1828 } 1829 export interface ListTrackersResponseEntry { 1830 /** 1831 * The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1832 */ 1833 CreateTime: Timestamp; 1834 /** 1835 * The description for the tracker resource. 1836 */ 1837 Description: ResourceDescription; 1838 /** 1839 * The pricing plan for the specified tracker resource. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page. 1840 */ 1841 PricingPlan: PricingPlan; 1842 /** 1843 * The specified data provider for the tracker resource. 1844 */ 1845 PricingPlanDataSource?: String; 1846 /** 1847 * The name of the tracker resource. 1848 */ 1849 TrackerName: ResourceName; 1850 /** 1851 * The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 1852 */ 1853 UpdateTime: Timestamp; 1854 } 1855 export type ListTrackersResponseEntryList = ListTrackersResponseEntry[]; 1856 export interface MapConfiguration { 1857 /** 1858 * Specifies the map style selected from an available data provider. For additional information on each map style and to preview each map style, see Esri map styles and HERE map styles. Valid Esri styles: VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content. RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide. VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content. VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style. VectorEsriStreets – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map. VectorEsriNavigation – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices. Valid HERE Technologies styles: VectorHereBerlin – The HERE Berlin map style is a high contrast detailed base map of the world that blends 3D and 2D rendering. When using HERE as your data provider, and selecting the Style VectorHereBerlin, you may not use HERE Technologies maps for Asset Management. See the AWS Service Terms for Amazon Location Service. 1859 */ 1860 Style: MapStyle; 1861 } 1862 export type MapStyle = string; 1863 export interface Place { 1864 /** 1865 * The numerical portion of an address, such as a building number. 1866 */ 1867 AddressNumber?: String; 1868 /** 1869 * A country/region specified using ISO 3166 3-digit country/region code. For example, CAN. 1870 */ 1871 Country?: String; 1872 Geometry: PlaceGeometry; 1873 /** 1874 * The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA. 1875 */ 1876 Label?: String; 1877 /** 1878 * A name for a local area, such as a city or town name. For example, Toronto. 1879 */ 1880 Municipality?: String; 1881 /** 1882 * The name of a community district. For example, Downtown. 1883 */ 1884 Neighborhood?: String; 1885 /** 1886 * A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location. 1887 */ 1888 PostalCode?: String; 1889 /** 1890 * A name for an area or geographical division, such as a province or state name. For example, British Columbia. 1891 */ 1892 Region?: String; 1893 /** 1894 * The name for a street or a road to identify a location. For example, Main Street. 1895 */ 1896 Street?: String; 1897 /** 1898 * A country, or an area that's part of a larger region . For example, Metro Vancouver. 1899 */ 1900 SubRegion?: String; 1901 } 1902 export interface PlaceGeometry { 1903 /** 1904 * A single point geometry specifies a location for a Place using WGS 84 coordinates: x — Specifies the x coordinate or longitude. y — Specifies the y coordinate or latitude. 1905 */ 1906 Point?: Position; 1907 } 1908 export type PlaceIndexSearchResultLimit = number; 1909 export type Position = Double[]; 1910 export type PricingPlan = "RequestBasedUsage"|"MobileAssetTracking"|"MobileAssetManagement"|string; 1911 export interface PutGeofenceRequest { 1912 /** 1913 * The geofence collection to store the geofence in. 1914 */ 1915 CollectionName: ResourceName; 1916 /** 1917 * An identifier for the geofence. For example, ExampleGeofence-1. 1918 */ 1919 GeofenceId: Id; 1920 /** 1921 * Contains the polygon details to specify the position of the geofence. Each geofence polygon can have a maximum of 1,000 vertices. 1922 */ 1923 Geometry: GeofenceGeometry; 1924 } 1925 export interface PutGeofenceResponse { 1926 /** 1927 * The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1928 */ 1929 CreateTime: Timestamp; 1930 /** 1931 * The geofence identifier entered in the request. 1932 */ 1933 GeofenceId: Id; 1934 /** 1935 * The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 1936 */ 1937 UpdateTime: Timestamp; 1938 } 1939 export type ResourceDescription = string; 1940 export type ResourceName = string; 1941 export interface SearchForPositionResult { 1942 /** 1943 * Contains details about the relevant point of interest. 1944 */ 1945 Place: Place; 1946 } 1947 export type SearchForPositionResultList = SearchForPositionResult[]; 1948 export interface SearchForTextResult { 1949 /** 1950 * Contains details about the relevant point of interest. 1951 */ 1952 Place: Place; 1953 } 1954 export type SearchForTextResultList = SearchForTextResult[]; 1955 export interface SearchPlaceIndexForPositionRequest { 1956 /** 1957 * The name of the place index resource you want to use for the search. 1958 */ 1959 IndexName: ResourceName; 1960 /** 1961 * An optional paramer. The maximum number of results returned per request. Default value: 50 1962 */ 1963 MaxResults?: PlaceIndexSearchResultLimit; 1964 /** 1965 * Specifies a coordinate for the query defined by a longitude, and latitude. The first position is the X coordinate, or longitude. The second position is the Y coordinate, or latitude. For example, position=xLongitude&position=yLatitude . 1966 */ 1967 Position: Position; 1968 } 1969 export interface SearchPlaceIndexForPositionResponse { 1970 /** 1971 * Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned. 1972 */ 1973 Results: SearchForPositionResultList; 1974 /** 1975 * Contains a summary of the request. 1976 */ 1977 Summary: SearchPlaceIndexForPositionSummary; 1978 } 1979 export interface SearchPlaceIndexForPositionSummary { 1980 /** 1981 * 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. 1982 */ 1983 DataSource: String; 1984 /** 1985 * An optional parameter. The maximum number of results returned per request. Default value: 50 1986 */ 1987 MaxResults?: PlaceIndexSearchResultLimit; 1988 /** 1989 * The position given in the reverse geocoding request. 1990 */ 1991 Position: Position; 1992 } 1993 export interface SearchPlaceIndexForTextRequest { 1994 /** 1995 * Searches for results closest to the given position. An optional parameter defined by longitude, and latitude. The first bias position is the X coordinate, or longitude. The second bias position is the Y coordinate, or latitude. For example, bias=xLongitude&bias=yLatitude. 1996 */ 1997 BiasPosition?: Position; 1998 /** 1999 * Filters the results by returning only Places within the provided bounding box. An optional parameter. 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. For example, bbox=xLongitudeSW&bbox=yLatitudeSW. The next 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. For example, bbox=xLongitudeNE&bbox=yLatitudeNE 2000 */ 2001 FilterBBox?: BoundingBox; 2002 /** 2003 * Limits the search to the given a list of countries/regions. An optional parameter. Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS. 2004 */ 2005 FilterCountries?: CountryCodeList; 2006 /** 2007 * The name of the place index resource you want to use for the search. 2008 */ 2009 IndexName: ResourceName; 2010 /** 2011 * An optional parameter. The maximum number of results returned per request. The default: 50 2012 */ 2013 MaxResults?: PlaceIndexSearchResultLimit; 2014 /** 2015 * The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street. 2016 */ 2017 Text: SyntheticSearchPlaceIndexForTextRequestString; 2018 } 2019 export interface SearchPlaceIndexForTextResponse { 2020 /** 2021 * A list of Places closest to the specified position. Each result contains additional information about the specific point of interest. 2022 */ 2023 Results: SearchForTextResultList; 2024 /** 2025 * Contains a summary of the request. Contains the BiasPosition, DataSource, FilterBBox, FilterCountries, MaxResults, ResultBBox, and Text. 2026 */ 2027 Summary: SearchPlaceIndexForTextSummary; 2028 } 2029 export interface SearchPlaceIndexForTextSummary { 2030 /** 2031 * Contains the coordinates for the bias position entered in the geocoding request. 2032 */ 2033 BiasPosition?: Position; 2034 /** 2035 * 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. 2036 */ 2037 DataSource: String; 2038 /** 2039 * Contains the coordinates for the optional bounding box coordinated entered in the geocoding request. 2040 */ 2041 FilterBBox?: BoundingBox; 2042 /** 2043 * Contains the country filter entered in the geocoding request. 2044 */ 2045 FilterCountries?: CountryCodeList; 2046 /** 2047 * Contains the maximum number of results indicated for the request. 2048 */ 2049 MaxResults?: PlaceIndexSearchResultLimit; 2050 /** 2051 * A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox. 2052 */ 2053 ResultBBox?: BoundingBox; 2054 /** 2055 * The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver. 2056 */ 2057 Text: SyntheticSearchPlaceIndexForTextSummaryString; 2058 } 2059 export interface Step { 2060 /** 2061 * The travel distance between the step's StartPosition and EndPosition. 2062 */ 2063 Distance: StepDistanceDouble; 2064 /** 2065 * 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. 2066 */ 2067 DurationSeconds: StepDurationSecondsDouble; 2068 /** 2069 * 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. 2070 */ 2071 EndPosition: Position; 2072 /** 2073 * 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. 2074 */ 2075 GeometryOffset?: StepGeometryOffsetInteger; 2076 /** 2077 * 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. 2078 */ 2079 StartPosition: Position; 2080 } 2081 export type StepDistanceDouble = number; 2082 export type StepDurationSecondsDouble = number; 2083 export type StepGeometryOffsetInteger = number; 2084 export type StepList = Step[]; 2085 export type String = string; 2086 export type SyntheticSearchPlaceIndexForTextRequestString = string; 2087 export type SyntheticSearchPlaceIndexForTextSummaryString = string; 2088 export type TagKey = string; 2089 export type TagKeys = String[]; 2090 export type TagMap = {[key: string]: TagValue}; 2091 export interface TagResourceRequest { 2092 /** 2093 * The Amazon Resource Name (ARN) of the resource whose tags you want to update. Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource 2094 */ 2095 ResourceArn: Arn; 2096 /** 2097 * Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: "TagKey" : "TagValue". Format example: {"tag1" : "value1", "tag2" : "value2"} 2098 */ 2099 Tags: TagMap; 2100 } 2101 export interface TagResourceResponse { 2102 } 2103 export type TagValue = string; 2104 export type Timestamp = Date; 2105 export type Token = string; 2106 export type TravelMode = "Car"|"Truck"|"Walking"|string; 2107 export interface TruckDimensions { 2108 /** 2109 * The height of the truck. For example, 4.5. 2110 */ 2111 Height?: TruckDimensionsHeightDouble; 2112 /** 2113 * The length of the truck. For example, 15.5. 2114 */ 2115 Length?: TruckDimensionsLengthDouble; 2116 /** 2117 * Specifies the unit of measurement for the truck dimensions. Default Value: Meters 2118 */ 2119 Unit?: DimensionUnit; 2120 /** 2121 * The width of the truck. For example, 4.5. 2122 */ 2123 Width?: TruckDimensionsWidthDouble; 2124 } 2125 export type TruckDimensionsHeightDouble = number; 2126 export type TruckDimensionsLengthDouble = number; 2127 export type TruckDimensionsWidthDouble = number; 2128 export interface TruckWeight { 2129 /** 2130 * The total weight of the truck. For example, 3500. 2131 */ 2132 Total?: TruckWeightTotalDouble; 2133 /** 2134 * The unit of measurement to use for the truck weight. Default Value: Kilograms 2135 */ 2136 Unit?: VehicleWeightUnit; 2137 } 2138 export type TruckWeightTotalDouble = number; 2139 export interface UntagResourceRequest { 2140 /** 2141 * The Amazon Resource Name (ARN) of the resource from which you want to remove tags. Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource 2142 */ 2143 ResourceArn: Arn; 2144 /** 2145 * The list of tag keys to remove from the specified resource. 2146 */ 2147 TagKeys: TagKeys; 2148 } 2149 export interface UntagResourceResponse { 2150 } 2151 export interface UpdateGeofenceCollectionRequest { 2152 /** 2153 * The name of the geofence collection to update. 2154 */ 2155 CollectionName: ResourceName; 2156 /** 2157 * Updates the description for the geofence collection. 2158 */ 2159 Description?: ResourceDescription; 2160 /** 2161 * Updates the pricing plan for the geofence collection. For more information about each pricing plan option restrictions, see Amazon Location Service pricing. 2162 */ 2163 PricingPlan?: PricingPlan; 2164 /** 2165 * Updates the data provider for the geofence collection. A 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. This can only be updated when updating the PricingPlan in the same request. Amazon Location Service 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 and Region unless you move it. 2166 */ 2167 PricingPlanDataSource?: String; 2168 } 2169 export interface UpdateGeofenceCollectionResponse { 2170 /** 2171 * The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection 2172 */ 2173 CollectionArn: Arn; 2174 /** 2175 * The name of the updated geofence collection. 2176 */ 2177 CollectionName: ResourceName; 2178 /** 2179 * The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ 2180 */ 2181 UpdateTime: Timestamp; 2182 } 2183 export interface UpdateMapRequest { 2184 /** 2185 * Updates the description for the map resource. 2186 */ 2187 Description?: ResourceDescription; 2188 /** 2189 * The name of the map resource to update. 2190 */ 2191 MapName: ResourceName; 2192 /** 2193 * Updates the pricing plan for the map resource. For more information about each pricing plan option restrictions, see Amazon Location Service pricing. 2194 */ 2195 PricingPlan?: PricingPlan; 2196 } 2197 export interface UpdateMapResponse { 2198 /** 2199 * The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:maps/ExampleMap 2200 */ 2201 MapArn: Arn; 2202 /** 2203 * The name of the updated map resource. 2204 */ 2205 MapName: ResourceName; 2206 /** 2207 * The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 2208 */ 2209 UpdateTime: Timestamp; 2210 } 2211 export interface UpdatePlaceIndexRequest { 2212 /** 2213 * Updates the data storage option for the place index resource. 2214 */ 2215 DataSourceConfiguration?: DataSourceConfiguration; 2216 /** 2217 * Updates the description for the place index resource. 2218 */ 2219 Description?: ResourceDescription; 2220 /** 2221 * The name of the place index resource to update. 2222 */ 2223 IndexName: ResourceName; 2224 /** 2225 * Updates the pricing plan for the place index resource. For more information about each pricing plan option restrictions, see Amazon Location Service pricing. 2226 */ 2227 PricingPlan?: PricingPlan; 2228 } 2229 export interface UpdatePlaceIndexResponse { 2230 /** 2231 * The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex 2232 */ 2233 IndexArn: Arn; 2234 /** 2235 * The name of the updated place index resource. 2236 */ 2237 IndexName: ResourceName; 2238 /** 2239 * The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 2240 */ 2241 UpdateTime: Timestamp; 2242 } 2243 export interface UpdateRouteCalculatorRequest { 2244 /** 2245 * The name of the route calculator resource to update. 2246 */ 2247 CalculatorName: ResourceName; 2248 /** 2249 * Updates the description for the route calculator resource. 2250 */ 2251 Description?: ResourceDescription; 2252 /** 2253 * Updates the pricing plan for the route calculator resource. For more information about each pricing plan option restrictions, see Amazon Location Service pricing. 2254 */ 2255 PricingPlan?: PricingPlan; 2256 } 2257 export interface UpdateRouteCalculatorResponse { 2258 /** 2259 * The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator 2260 */ 2261 CalculatorArn: Arn; 2262 /** 2263 * The name of the updated route calculator resource. 2264 */ 2265 CalculatorName: ResourceName; 2266 /** 2267 * The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 2268 */ 2269 UpdateTime: Timestamp; 2270 } 2271 export interface UpdateTrackerRequest { 2272 /** 2273 * Updates the description for the tracker resource. 2274 */ 2275 Description?: ResourceDescription; 2276 /** 2277 * Updates the pricing plan for the tracker resource. For more information about each pricing plan option restrictions, see Amazon Location Service pricing. 2278 */ 2279 PricingPlan?: PricingPlan; 2280 /** 2281 * Updates the data provider for the tracker resource. A 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 This can only be updated when updating the PricingPlan in the same request. Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it. 2282 */ 2283 PricingPlanDataSource?: String; 2284 /** 2285 * The name of the tracker resource to update. 2286 */ 2287 TrackerName: ResourceName; 2288 } 2289 export interface UpdateTrackerResponse { 2290 /** 2291 * The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS. Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker 2292 */ 2293 TrackerArn: Arn; 2294 /** 2295 * The name of the updated tracker resource. 2296 */ 2297 TrackerName: ResourceName; 2298 /** 2299 * The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. 2300 */ 2301 UpdateTime: Timestamp; 2302 } 2303 export type VehicleWeightUnit = "Kilograms"|"Pounds"|string; 2304 /** 2305 * 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. 2306 */ 2307 export type apiVersion = "2020-11-19"|"latest"|string; 2308 export interface ClientApiVersions { 2309 /** 2310 * 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. 2311 */ 2312 apiVersion?: apiVersion; 2313 } 2314 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 2315 /** 2316 * Contains interfaces for use with the Location client. 2317 */ 2318 export import Types = Location; 2319 } 2320 export = Location;