Class: AWS.Location
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Location
- Identifier:
- location
- API Version:
- 2020-11-19
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Suite of geospatial services including Maps, Places, Tracking, and Geofencing
Sending a Request Using Location
var location = new AWS.Location();
location.associateTrackerConsumer(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Location object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var location = new AWS.Location({apiVersion: '2020-11-19'});
You can also set the API version globally in AWS.config.apiVersions
using
the location service identifier:
AWS.config.apiVersions = {
location: '2020-11-19',
// other service API versions
};
var location = new AWS.Location();
Constructor Summary collapse
-
new AWS.Location(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
associateTrackerConsumer(params = {}, callback) ⇒ AWS.Request
Creates an association between a geofence collection and a tracker resource.
-
batchDeleteGeofence(params = {}, callback) ⇒ AWS.Request
Deletes a batch of geofences from a geofence collection.
-
batchEvaluateGeofences(params = {}, callback) ⇒ AWS.Request
Used in geofence monitoring.
-
batchGetDevicePosition(params = {}, callback) ⇒ AWS.Request
A batch request to retrieve device positions.
-
batchPutGeofence(params = {}, callback) ⇒ AWS.Request
A batch request for storing geofences into a given geofence collection.
-
batchUpdateDevicePosition(params = {}, callback) ⇒ AWS.Request
Uploads a position update for one or more devices to a tracker resource.
-
createGeofenceCollection(params = {}, callback) ⇒ AWS.Request
Creates a geofence collection, which manages and stores geofences.
-
createMap(params = {}, callback) ⇒ AWS.Request
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
-
createPlaceIndex(params = {}, callback) ⇒ AWS.Request
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
-
createTracker(params = {}, callback) ⇒ AWS.Request
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
-
deleteGeofenceCollection(params = {}, callback) ⇒ AWS.Request
Deletes a geofence collection from your AWS account.
-
deleteMap(params = {}, callback) ⇒ AWS.Request
Deletes a map resource from your AWS account.
-
deletePlaceIndex(params = {}, callback) ⇒ AWS.Request
Deletes a Place index resource from your AWS account.
-
deleteTracker(params = {}, callback) ⇒ AWS.Request
Deletes a tracker resource from your AWS account.
-
describeGeofenceCollection(params = {}, callback) ⇒ AWS.Request
Retrieves the geofence collection details.
-
describeMap(params = {}, callback) ⇒ AWS.Request
Retrieves the map resource details.
-
describePlaceIndex(params = {}, callback) ⇒ AWS.Request
Retrieves the Place index resource details.
-
describeTracker(params = {}, callback) ⇒ AWS.Request
Retrieves the tracker resource details.
-
disassociateTrackerConsumer(params = {}, callback) ⇒ AWS.Request
Removes the association bewteen a tracker resource and a geofence collection.
-
getDevicePosition(params = {}, callback) ⇒ AWS.Request
Retrieves the latest device position.
-
getDevicePositionHistory(params = {}, callback) ⇒ AWS.Request
Retrieves the device position history from a tracker resource within a specified range of time.
-
getGeofence(params = {}, callback) ⇒ AWS.Request
Retrieves the geofence details from a geofence collection.
-
getMapGlyphs(params = {}, callback) ⇒ AWS.Request
Retrieves glyphs used to display labels on a map.
-
getMapSprites(params = {}, callback) ⇒ AWS.Request
Retrieves the sprite sheet corresponding to a map resource.
-
getMapStyleDescriptor(params = {}, callback) ⇒ AWS.Request
Retrieves the map style descriptor from a map resource.
-
getMapTile(params = {}, callback) ⇒ AWS.Request
Retrieves a vector data tile from the map resource.
-
listGeofenceCollections(params = {}, callback) ⇒ AWS.Request
Lists geofence collections in your AWS account.
-
listGeofences(params = {}, callback) ⇒ AWS.Request
Lists geofences stored in a given geofence collection.
-
listMaps(params = {}, callback) ⇒ AWS.Request
Lists map resources in your AWS account.
-
listPlaceIndexes(params = {}, callback) ⇒ AWS.Request
Lists Place index resources in your AWS account.
-
listTrackerConsumers(params = {}, callback) ⇒ AWS.Request
Lists geofence collections currently associated to the given tracker resource.
-
listTrackers(params = {}, callback) ⇒ AWS.Request
Lists tracker resources in your AWS account.
-
putGeofence(params = {}, callback) ⇒ AWS.Request
Stores a geofence to a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
-
searchPlaceIndexForPosition(params = {}, callback) ⇒ AWS.Request
Reverse geocodes a given coordinate and returns a legible address.
-
searchPlaceIndexForText(params = {}, callback) ⇒ AWS.Request
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.Location(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
associateTrackerConsumer(params = {}, callback) ⇒ AWS.Request
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.
batchDeleteGeofence(params = {}, callback) ⇒ AWS.Request
Deletes a batch of geofences from a geofence collection.
batchEvaluateGeofences(params = {}, callback) ⇒ AWS.Request
Used in geofence monitoring. Evaluates device positions against the position of geofences in a given geofence collection.
batchGetDevicePosition(params = {}, callback) ⇒ AWS.Request
A batch request to retrieve device positions.
batchPutGeofence(params = {}, callback) ⇒ AWS.Request
A batch request for storing geofences into a given geofence collection.
batchUpdateDevicePosition(params = {}, callback) ⇒ AWS.Request
Uploads a position update for one or more devices to a tracker resource. The data is used for API queries requesting the device position and position history.
createGeofenceCollection(params = {}, callback) ⇒ AWS.Request
Creates a geofence collection, which manages and stores geofences.
createMap(params = {}, callback) ⇒ AWS.Request
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
createPlaceIndex(params = {}, callback) ⇒ AWS.Request
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
createTracker(params = {}, callback) ⇒ AWS.Request
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
deleteGeofenceCollection(params = {}, callback) ⇒ AWS.Request
Deletes a geofence collection from your AWS account.
deleteMap(params = {}, callback) ⇒ AWS.Request
Deletes a map resource from your AWS account.
deletePlaceIndex(params = {}, callback) ⇒ AWS.Request
Deletes a Place index resource from your AWS account.
deleteTracker(params = {}, callback) ⇒ AWS.Request
Deletes a tracker resource from your AWS account.
describeGeofenceCollection(params = {}, callback) ⇒ AWS.Request
Retrieves the geofence collection details.
disassociateTrackerConsumer(params = {}, callback) ⇒ AWS.Request
Removes the association bewteen a tracker resource and a geofence collection.
getDevicePosition(params = {}, callback) ⇒ AWS.Request
Retrieves the latest device position.
getDevicePositionHistory(params = {}, callback) ⇒ AWS.Request
Retrieves the device position history from a tracker resource within a specified range of time.
getGeofence(params = {}, callback) ⇒ AWS.Request
Retrieves the geofence details from a geofence collection.
getMapSprites(params = {}, callback) ⇒ AWS.Request
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.
getMapStyleDescriptor(params = {}, callback) ⇒ AWS.Request
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.
getMapTile(params = {}, callback) ⇒ AWS.Request
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. They are 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).
listGeofenceCollections(params = {}, callback) ⇒ AWS.Request
Lists geofence collections in your AWS account.
listGeofences(params = {}, callback) ⇒ AWS.Request
Lists geofences stored in a given geofence collection.
listPlaceIndexes(params = {}, callback) ⇒ AWS.Request
Lists Place index resources in your AWS account.
listTrackerConsumers(params = {}, callback) ⇒ AWS.Request
Lists geofence collections currently associated to the given tracker resource.
putGeofence(params = {}, callback) ⇒ AWS.Request
Stores a geofence to a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
searchPlaceIndexForPosition(params = {}, callback) ⇒ AWS.Request
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
searchPlaceIndexForText(params = {}, callback) ⇒ AWS.Request
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.
BiasPosition
, or filter results within a bounding box using FilterBBox
. Providing both parameters simultaneously returns an error. Storage
option for the IntendedUse
parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.