Amazon Web Services, Inc.

Amazon Location Service

"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"

Maps & location#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"

Endpoints 64

Tracker

  • POSTAssociate tracker consumer/tracking/v0/trackers/:TrackerName/consumersCreates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked…
  • POSTBatch delete device position history/tracking/v0/trackers/:TrackerName/delete-positionsDeletes the position history of one or more devices from a tracker resource.
  • POSTBatch get device position/tracking/v0/trackers/:TrackerName/get-positionsLists the latest device positions for requested devices.
  • POSTBatch update device position/tracking/v0/trackers/:TrackerName/positionsUploads 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…
  • POSTCreate tracker/tracking/v0/trackersCreates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
  • GETDescribe tracker/tracking/v0/trackers/:TrackerNameRetrieves the tracker resource details.
  • DELETEDelete tracker/tracking/v0/trackers/:TrackerNameDeletes a tracker resource from your Amazon Web Services account. This operation deletes the resource permanently. If the tracker resource is in use, you may…
  • PATCHUpdate tracker/tracking/v0/trackers/:TrackerNameUpdates the specified properties of a given tracker resource.
  • DELETEDisassociate tracker consumer/tracking/v0/trackers/:TrackerName/consumers/:ConsumerArnRemoves the association between a tracker resource and a geofence collection. Once you unlink a tracker resource from a geofence collection, the tracker…
  • GETGet device position/tracking/v0/trackers/:TrackerName/devices/:DeviceId/positions/latestRetrieves a device's most recent position according to its sample time. Device positions are deleted after 30 days.
  • POSTGet device position history/tracking/v0/trackers/:TrackerName/devices/:DeviceId/list-positionsRetrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after 30 days.
  • POSTList device positions/tracking/v0/trackers/:TrackerName/list-positionsA batch request to retrieve all device positions.
  • POSTList tracker consumers/tracking/v0/trackers/:TrackerName/list-consumersLists geofence collections currently associated to the given tracker resource.
  • POSTList trackers/tracking/v0/list-trackersLists tracker resources in your Amazon Web Services account.
  • POSTVerify device position/tracking/v0/trackers/:TrackerName/positions/verifyVerifies 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…

Geofence collection

  • POSTBatch delete geofence/geofencing/v0/collections/:CollectionName/delete-geofencesDeletes a batch of geofences from a geofence collection. This operation deletes the resource permanently.
  • POSTBatch evaluate geofences/geofencing/v0/collections/:CollectionName/positionsEvaluates device positions against the geofence geometries from a given geofence collection. This operation always returns an empty response because geofences…
  • POSTBatch put geofence/geofencing/v0/collections/:CollectionName/put-geofencesA 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…
  • POSTCreate geofence collection/geofencing/v0/collectionsCreates a geofence collection, which manages and stores geofences.
  • GETDescribe geofence collection/geofencing/v0/collections/:CollectionNameRetrieves the geofence collection details.
  • DELETEDelete geofence collection/geofencing/v0/collections/:CollectionNameDeletes a geofence collection from your Amazon Web Services account. This operation deletes the resource permanently. If the geofence collection is the target…
  • PATCHUpdate geofence collection/geofencing/v0/collections/:CollectionNameUpdates the specified properties of a given geofence collection.
  • POSTForecast geofence events/geofencing/v0/collections/:CollectionName/forecast-geofence-eventsThis 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…
  • GETGet geofence/geofencing/v0/collections/:CollectionName/geofences/:GeofenceIdRetrieves the geofence details from a geofence collection. The returned geometry will always match the geometry format used when the geofence was created.
  • PUTPut geofence/geofencing/v0/collections/:CollectionName/geofences/:GeofenceIdStores 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.
  • POSTList geofence collections/geofencing/v0/list-collectionsLists geofence collections in your Amazon Web Services account.
  • POSTList geofences/geofencing/v0/collections/:CollectionName/list-geofencesLists geofences stored in a given geofence collection.

Route calculator

  • POSTCalculate route/routes/v0/calculators/:CalculatorName/calculate/route?key=stringThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to CalculateRoutes or CalculateIsolines unless you require…
  • POSTCalculate route matrix/routes/v0/calculators/:CalculatorName/calculate/route-matrix?key=stringThis 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.…
  • POSTCreate route calculator/routes/v0/calculatorsThis 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.…
  • GETDescribe route calculator/routes/v0/calculators/:CalculatorNameThis 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.…
  • DELETEDelete route calculator/routes/v0/calculators/:CalculatorNameThis 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.…
  • PATCHUpdate route calculator/routes/v0/calculators/:CalculatorNameThis 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.…
  • POSTList route calculators/routes/v0/list-calculatorsThis 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.…

Job

  • POSTCancel job/metadata/v0/jobs/cancel-jobCancelJob cancels a job that is currently running or pending. If the job is already in a terminal state ( Completed , Failed , or Cancelled ), the operation…
  • GETGet job/metadata/v0/jobs/:JobIdGetJob retrieves detailed information about a specific job, including its current status, configuration, and error information if the job failed. For more…
  • POSTList jobs/metadata/v0/jobs/list-jobsListJobs retrieves a list of jobs with optional filtering and pagination support. For more information, see Job concepts in the Amazon Location Service…
  • POSTStart job/metadata/v0/jobsStartJob starts a new asynchronous bulk processing job. You specify the input data location in Amazon S3, the action to perform, and the output location where…

Api key

  • POSTCreate key/metadata/v0/keysCreates 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…
  • GETDescribe key/metadata/v0/keys/:KeyNameRetrieves the API key resource details. For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide .
  • DELETEDelete key/metadata/v0/keys/:KeyName?forceDelete=trueDeletes 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…
  • PATCHUpdate key/metadata/v0/keys/:KeyNameUpdates the specified properties of a given API key resource.
  • POSTList keys/metadata/v0/list-keysLists API key resources in your Amazon Web Services account. For more information, see Use API keys to authenticate in the Amazon Location Service Developer…

Map

  • POSTCreate map/maps/v0/mapsThis 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…
  • GETDescribe map/maps/v0/maps/:MapNameThis 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…
  • DELETEDelete map/maps/v0/maps/:MapNameThis 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…
  • PATCHUpdate map/maps/v0/maps/:MapNameThis 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…
  • GETGet map glyphs/maps/v0/maps/:MapName/glyphs/:FontStack/:FontUnicodeRange?key=stringThis operation is no longer current and may be deprecated in the future. We recommend upgrading to GetGlyphs unless you require Grab data. GetMapGlyphs is…
  • GETGet map sprites/maps/v0/maps/:MapName/sprites/:FileName?key=stringThis operation is no longer current and may be deprecated in the future. We recommend upgrading to GetSprites unless you require Grab data. GetMapSprites is…
  • GETGet map style descriptor/maps/v0/maps/:MapName/style-descriptor?key=stringThis operation is no longer current and may be deprecated in the future. We recommend upgrading to GetStyleDescriptor unless you require Grab data.…
  • GETGet map tile/maps/v0/maps/:MapName/tiles/:Z/:X/:Y?key=stringThis 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…
  • POSTList maps/maps/v0/list-mapsThis 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…

Place index

  • POSTCreate place index/places/v0/indexesThis 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.…
  • GETDescribe place index/places/v0/indexes/:IndexNameThis 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.…
  • DELETEDelete place index/places/v0/indexes/:IndexNameThis 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.…
  • PATCHUpdate place index/places/v0/indexes/:IndexNameThis 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.…
  • GETGet place/places/v0/indexes/:IndexName/places/:PlaceId?language=string&key=stringThis 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.…
  • POSTList place indexes/places/v0/list-indexesThis 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.…
  • POSTSearch place index for position/places/v0/indexes/:IndexName/search/position?key=stringThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to ReverseGeocode or SearchNearby unless you require Grab…
  • POSTSearch place index for suggestions/places/v0/indexes/:IndexName/search/suggestions?key=stringThis 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.…
  • POSTSearch place index for text/places/v0/indexes/:IndexName/search/text?key=stringThis 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.…

Generic

  • GETList tags for resource/tags/:ResourceArnReturns a list of tags that are applied to the specified Amazon Location resource.
  • POSTTag resource/tags/:ResourceArnAssigns one or more tags (key-value pairs) to the specified Amazon Location Service resource. Tags can help you organize and categorize your resources. You…
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes one or more tags from the specified Amazon Location resource.

API details

Base URL
https://geo.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
64 operations on 49 pathsPOST 34GET 15DELETE 8PATCH 6PUT 1
Main resources
Tracker 15Geofence collection 12Map 9Place index 9Route calculator 7Api key 5Job 4Generic 3
Description format
AWS Smithy model, API version 2020-11-19

How to test the Amazon Location Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Location Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate tracker consumer” (POST /tracking/v0/trackers/:TrackerName/consumers), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Location Service?

"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing" It is listed under Maps & location and has 64 endpoints.

Who publishes the Amazon Location Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Location Service?

Requests go to https://geo.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Location Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Location Service have?

64 operations on 49 paths (34 POST, 15 GET, 8 DELETE, 6 PATCH, 1 PUT). The largest groups are Tracker, Geofence collection, Map, Place index.

Is forking the Amazon Location Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.