View Source AWS.Location (aws-elixir v1.0.10)
"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
Link to this section Summary
Functions
Creates an association between a geofence collection and a tracker resource.
Deletes the position history of one or more devices from a tracker resource.
Deletes a batch of geofences from a geofence collection.
Evaluates device positions against the geofence geometries from a given geofence collection.
Lists the latest device positions for requested devices.
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.
Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
Creates a geofence collection, which manages and stores geofences.
Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
Deletes a geofence collection from your Amazon Web Services account.
Deletes the specified API key.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
Deletes a tracker resource from your Amazon Web Services account.
Retrieves the geofence collection details.
Retrieves the API key resource details.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
Retrieves the tracker resource details.
Removes the association between a tracker resource and a geofence collection.
This action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed.
Retrieves a device's most recent position according to its sample time.
Retrieves the device position history from a tracker resource within a specified range of time.
Retrieves the geofence details from a geofence collection.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
A batch request to retrieve all device positions.
Lists geofence collections in your Amazon Web Services account.
Lists geofences stored in a given geofence collection.
Lists API key resources in your Amazon Web Services account.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
Returns a list of tags that are applied to the specified Amazon Location resource.
Lists geofence collections currently associated to the given tracker resource.
Lists tracker resources in your Amazon Web Services account.
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.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
Removes one or more tags from the specified Amazon Location resource.
Updates the specified properties of a given geofence collection.
Updates the specified properties of a given API key resource.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
This operation is no longer current and may be deprecated in the future.
Updates the specified properties of a given tracker resource.
Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.
Link to this section Functions
associate_tracker_consumer(client, tracker_name, input, options \\ [])
View SourceCreates 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.
batch_delete_device_position_history(client, tracker_name, input, options \\ [])
View SourceDeletes the position history of one or more devices from a tracker resource.
batch_delete_geofence(client, collection_name, input, options \\ [])
View SourceDeletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
batch_evaluate_geofences(client, collection_name, input, options \\ [])
View SourceEvaluates 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:
ENTERif Amazon Location determines that the tracked device has entered a geofenced area.EXITif 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.
Geofence evaluation uses the given device position. It does not account for the
optional Accuracy of a DevicePositionUpdate.
The DeviceID is used as a string to represent the device. You do not need to
have a Tracker associated with the DeviceID.
batch_get_device_position(client, tracker_name, input, options \\ [])
View SourceLists the latest device positions for requested devices.
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.
batch_update_device_position(client, tracker_name, input, options \\ [])
View SourceUploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).
Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.
Position updates are handled based on the PositionFiltering property of the
tracker. When PositionFiltering is set to TimeBased, updates are evaluated
against linked geofence collections, and location data is stored at a maximum of
one position per 30 second interval. If your update frequency is more often than
every 30 seconds, only one update per 30 seconds is stored for each unique
device ID.
When PositionFiltering is set to DistanceBased filtering, location data is
stored and evaluated against linked geofence collections only if the device has
moved more than 30 m (98.4 ft).
When PositionFiltering is set to AccuracyBased filtering, location data is
stored and evaluated against linked geofence collections only if the device has
moved more than the measured accuracy. For example, if two consecutive updates
from a device have a horizontal accuracy of 5 m and 10 m, the second update is
neither stored or evaluated if the device has moved less than 15 m. If
PositionFiltering is set to AccuracyBased filtering, Amazon Location uses
the default value { "Horizontal": 0} when accuracy is not provided on a
DevicePositionUpdate.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to CalculateRoutes
or
CalculateIsolines
unless you require Grab data.
CalculateRoute is part of a previous Amazon Location Service
Routes API (version 1) which has been superseded by a more intuitive, powerful,
and complete API (version 2).
The version 2 CalculateRoutes operation gives better results for
point-to-point routing, while the version 2 CalculateIsolines operation adds
support for calculating service areas and travel time envelopes.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Routes API version 2 is found under geo-routes or
geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Calculates a route
given the following required parameters: DeparturePosition 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
DepartureTimeorDepartNow. This calculates a route based on predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request.
Specifying both parameters returns a validation error.
- Specifying a travel mode
using TravelMode sets the transportation mode used to calculate the routes. This
also lets you specify additional route preferences in
CarModeOptionsif traveling byCar, orTruckModeOptionsif traveling byTruck.
If you specify walking for the travel mode and your data provider is Esri, the
start and destination must be within 40km.
calculate_route_matrix(client, calculator_name, input, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the V2 CalculateRouteMatrix
unless you
require Grab data.
This version of CalculateRouteMatrix is part of a previous Amazon
Location Service Routes API (version 1) which has been superseded by a more
intuitive, powerful, and complete API (version 2).
The version 2 CalculateRouteMatrix operation gives better results
for matrix routing calculations.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Routes API version 2 is found under geo-routes or
geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Routes V2 API Reference
or the Developer Guide.
Calculates a route
matrix
given the following required parameters: DeparturePositions and
DestinationPositions. CalculateRouteMatrix calculates routes and returns the
travel time and travel distance from each departure position to each destination
position in the request. For example, given departure positions A and B, and
destination positions X and Y, CalculateRouteMatrix will return time and
distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The
number of results returned (and routes calculated) will be the number of
DeparturePositions times the number of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
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 routes.
Additional options include:
- Specifying a departure time
using either
DepartureTimeorDepartNow. This calculates routes based on predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request.
Specifying both parameters returns a validation error.
- Specifying a travel mode
using TravelMode sets the transportation mode used to calculate the routes. This
also lets you specify additional route preferences in
CarModeOptionsif traveling byCar, orTruckModeOptionsif traveling byTruck.
Creates a geofence collection, which manages and stores geofences.
Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.
For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.
This operation is no longer current and may be deprecated in the future.
We recommend upgrading to the Maps API V2 unless you require Grab data.
CreateMap is part of a previous Amazon Location Service Maps API
(version 1) which has been superseded by a more intuitive, powerful, and
complete API (version 2).
The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Places API V2 unless you require Grab data.
CreatePlaceIndex is part of a previous Amazon Location Service
Places API (version 1) which has been superseded by a more intuitive, powerful,
and complete API (version 2).
The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Places V2 API Reference
or the Developer Guide.
Creates a place index resource in your Amazon Web Services account. Use a place
index resource to geocode addresses and other text queries by using the
SearchPlaceIndexForText operation, and reverse geocode coordinates by using
the SearchPlaceIndexForPosition operation, and enable autosuggestions by using
the SearchPlaceIndexForSuggestions operation.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Routes API V2 unless you require Grab data.
CreateRouteCalculator is part of a previous Amazon Location
Service Routes API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Routes API version 2 is found under geo-routes or
geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide. Creates a route calculator resource in your Amazon Web Services 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.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
delete_geofence_collection(client, collection_name, input, options \\ [])
View SourceDeletes a geofence collection from your Amazon Web Services 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.
Deletes the specified API key.
The API key must have been deactivated more than 90 days previously.
For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.
This operation is no longer current and may be deprecated in the future.
We recommend upgrading to the Maps API V2 unless you require Grab data.
DeleteMap is part of a previous Amazon Location Service Maps API
(version 1) which has been superseded by a more intuitive, powerful, and
complete API (version 2).
The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
Deletes a map resource from your Amazon Web Services account.
This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Places API V2 unless you require Grab data.
DeletePlaceIndex is part of a previous Amazon Location Service
Places API (version 1) which has been superseded by a more intuitive, powerful,
and complete API (version 2).
The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.
Deletes a place index resource from your Amazon Web Services account.
This operation deletes the resource permanently.
delete_route_calculator(client, calculator_name, input, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Routes API V2 unless you require Grab data.
DeleteRouteCalculator is part of a previous Amazon Location
Service Routes API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Routes API version 2 is found under geo-routes or
geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide.
Deletes a route calculator resource from your Amazon Web Services account.
This operation deletes the resource permanently.
Deletes a tracker resource from your Amazon Web Services 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.
describe_geofence_collection(client, collection_name, options \\ [])
View SourceRetrieves the geofence collection details.
Retrieves the API key resource details.
For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.
This operation is no longer current and may be deprecated in the future.
We recommend upgrading to the Maps API V2 unless you require Grab data.
DescribeMap is part of a previous Amazon Location Service Maps
API (version 1) which has been superseded by a more intuitive, powerful, and
complete API (version 2).
The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
Retrieves the map resource details.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Places API V2 unless you require Grab data.
DescribePlaceIndex is part of a previous Amazon Location Service
Places API (version 1) which has been superseded by a more intuitive, powerful,
and complete API (version 2).
The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.
Retrieves the place index resource details.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Routes API V2 unless you require Grab data.
DescribeRouteCalculator is part of a previous Amazon Location
Service Routes API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Routes API version 2 is found under geo-routes or
geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide.
Retrieves the route calculator resource details.
Retrieves the tracker resource details.
disassociate_tracker_consumer(client, consumer_arn, tracker_name, input, options \\ [])
View SourceRemoves 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.
forecast_geofence_events(client, collection_name, input, options \\ [])
View SourceThis action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed.
Each forecasted event is associated with a geofence from a provided geofence collection. A forecast event can have one of the following states:
ENTER: The device position is outside the referenced geofence, but the device
may cross into the geofence during the forecasting time horizon if it maintains
its current speed.
EXIT: The device position is inside the referenced geofence, but the device
may leave the geofence during the forecasted time horizon if the device
maintains it's current speed.
IDLE:The device is inside the geofence, and it will remain inside the geofence
through the end of the time horizon if the device maintains it's current speed.
Heading direction is not considered in the current version. The API takes a conservative approach and includes events that can occur for any heading.
get_device_position(client, device_id, tracker_name, options \\ [])
View SourceRetrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
get_device_position_history(client, device_id, tracker_name, input, options \\ [])
View SourceRetrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
Retrieves the geofence details from a geofence collection.
The returned geometry will always match the geometry format used when the geofence was created.
get_map_glyphs(client, font_stack, font_unicode_range, map_name, key \\ nil, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend upgrading to GetGlyphs
unless you require Grab data.
GetMapGlyphs is part of a previous Amazon Location Service Maps
API (version 1) which has been superseded by a more intuitive, powerful, and
complete API (version 2).
The version 2 GetGlyphs operation gives a better user experience
and is compatible with the remainder of the V2 Maps API.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
Retrieves glyphs used to display labels on a map.
get_map_sprites(client, file_name, map_name, key \\ nil, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend upgrading to GetSprites
unless you require Grab data.
GetMapSprites is part of a previous Amazon Location Service Maps
API (version 1) which has been superseded by a more intuitive, powerful, and
complete API (version 2).
The version 2 GetSprites operation gives a better user experience
and is compatible with the remainder of the V2 Maps API.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
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.
get_map_style_descriptor(client, map_name, key \\ nil, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend upgrading to GetStyleDescriptor
unless you require Grab data.
GetMapStyleDescriptor is part of a previous Amazon Location
Service Maps API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
The version 2 GetStyleDescriptor operation gives a better user
experience and is compatible with the remainder of the V2 Maps API.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
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.
get_map_tile(client, map_name, x, y, z, key \\ nil, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend upgrading to GetTile
unless you require Grab data.
GetMapTile is part of a previous Amazon Location Service Maps API
(version 1) which has been superseded by a more intuitive, powerful, and
complete API (version 2).
The version 2 GetTile operation gives a better user experience
and is compatible with the remainder of the V2 Maps API.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
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).
get_place(client, index_name, place_id, key \\ nil, language \\ nil, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the V2 GetPlace
operation unless
you require Grab data.
This version of GetPlace is part of a previous Amazon Location
Service Places API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
Version 2 of the GetPlace operation interoperates with the rest
of the Places V2 API, while this version does not.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Places V2 API Reference
or the Developer Guide.
Finds a place by its unique ID. A PlaceId is returned by other search
operations.
A PlaceId is valid only if all of the following are the same in the original
search request and the call to GetPlace.
Customer Amazon Web Services account
Amazon Web Services Region
Data provider specified in the place index resource
If your Place index resource is configured with Grab as your geolocation provider and Storage as Intended use, the GetPlace operation is unavailable. For more information, see AWS service terms.
A batch request to retrieve all device positions.
Lists geofence collections in your Amazon Web Services account.
Lists geofences stored in a given geofence collection.
Lists API key resources in your Amazon Web Services account.
For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.
This operation is no longer current and may be deprecated in the future.
We recommend upgrading to the Maps API V2 unless you require Grab data.
ListMaps is part of a previous Amazon Location Service Maps API
(version 1) which has been superseded by a more intuitive, powerful, and
complete API (version 2).
The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
Lists map resources in your Amazon Web Services account.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Places API V2 unless you require Grab data.
ListPlaceIndexes is part of a previous Amazon Location Service
Places API (version 1) which has been superseded by a more intuitive, powerful,
and complete API (version 2).
The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.
Lists place index resources in your Amazon Web Services account.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Routes API V2 unless you require Grab data.
ListRouteCalculators is part of a previous Amazon Location
Service Routes API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Routes API version 2 is found under geo-routes or
geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide.
Lists route calculator resources in your Amazon Web Services account.
Returns a list of tags that are applied to the specified Amazon Location resource.
list_tracker_consumers(client, tracker_name, input, options \\ [])
View SourceLists geofence collections currently associated to the given tracker resource.
Lists tracker resources in your Amazon Web Services account.
put_geofence(client, collection_name, geofence_id, input, options \\ [])
View SourceStores 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.
search_place_index_for_position(client, index_name, input, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend you upgrade to ReverseGeocode
or
SearchNearby
unless you require Grab data.
SearchPlaceIndexForPosition is part of a previous Amazon Location
Service Places API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
The version 2 ReverseGeocode operation gives better results in
the address reverse-geocoding use case, while the version 2 SearchNearby
operation gives better results when searching for businesses and points of
interest near a specific location.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
search_place_index_for_suggestions(client, index_name, input, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend you upgrade to Suggest
or Autocomplete
unless you
require Grab data.
SearchPlaceIndexForSuggestions is part of a previous Amazon
Location Service Places API (version 1) which has been superseded by a more
intuitive, powerful, and complete API (version 2).
The version 2 Suggest operation gives better results for
typeahead place search suggestions with fuzzy matching, while the version 2
Autocomplete operation gives better results for address completion based on
partial input.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
You can search for suggested place names near a specified position by using
BiasPosition, or filter results within a bounding box by using FilterBBox.
These parameters are mutually exclusive; using both BiasPosition and
FilterBBox in the same command returns an error.
search_place_index_for_text(client, index_name, input, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend you upgrade to Geocode
or SearchText
unless you
require Grab data.
SearchPlaceIndexForText is part of a previous Amazon Location
Service Places API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
The version 2 Geocode operation gives better results in the
address geocoding use case, while the version 2 SearchText operation gives
better results when searching for businesses and points of interest.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
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.
Search results are returned in order of highest to lowest relevance.
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
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.
You can use the TagResource 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.
You can associate up to 50 tags with a resource.
Removes one or more tags from the specified Amazon Location resource.
update_geofence_collection(client, collection_name, input, options \\ [])
View SourceUpdates the specified properties of a given geofence collection.
Updates the specified properties of a given API key resource.
This operation is no longer current and may be deprecated in the future.
We recommend upgrading to the Maps API V2 unless you require Grab data.
UpdateMap is part of a previous Amazon Location Service Maps API
(version 1) which has been superseded by a more intuitive, powerful, and
complete API (version 2).
The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.
If you are using an AWS SDK or the AWS CLI, note that the Maps API
version 2 is found under geo-maps or geo_maps, not under location.
Since Grab is not yet fully supported in Maps API version 2, we
recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.
Updates the specified properties of a given map resource.
This operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Places API V2 unless you require Grab data.
UpdatePlaceIndex is part of a previous Amazon Location Service
Places API (version 1) which has been superseded by a more intuitive, powerful,
and complete API (version 2).
The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Places API version 2 is found under geo-places or
geo_places, not under location.
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.
Updates the specified properties of a given place index resource.
update_route_calculator(client, calculator_name, input, options \\ [])
View SourceThis operation is no longer current and may be deprecated in the future.
We recommend you upgrade to the Routes API V2 unless you require Grab data.
UpdateRouteCalculator is part of a previous Amazon Location
Service Routes API (version 1) which has been superseded by a more intuitive,
powerful, and complete API (version 2).
The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.
If you are using an Amazon Web Services SDK or the Amazon Web
Services CLI, note that the Routes API version 2 is found under geo-routes or
geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide.
Updates the specified properties for a given route calculator resource.
Updates the specified properties of a given tracker resource.
verify_device_position(client, tracker_name, input, options \\ [])
View SourceVerifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.
The Location Integrity SDK provides enhanced features related to device verification, and it is available for use by request. To get access to the SDK, contact Sales Support.