aws location

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

Subcommands

NameDescription
associate-tracker-consumerCreates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. 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-geofenceDeletes a batch of geofences from a geofence collection. This action deletes the resource permanently. You can't undo this action
batch-evaluate-geofencesEvaluates device positions against the geofence geometries from a given geofence collection. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge. The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update
batch-get-device-positionA batch request to retrieve all device positions
batch-put-geofenceA batch request for storing geofence geometries into a given geofence collection
batch-update-device-positionUploads 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 one year before it is deleted
create-geofence-collectionCreates a geofence collection, which manages and stores geofences
create-mapCreates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers. By using Maps, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. For more information, see the AWS Service Terms for Amazon Location Service
create-place-indexCreates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider. By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service
create-trackerCreates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices
delete-geofence-collectionDeletes a geofence collection from your AWS account. This action deletes the resource permanently. You can't undo this action. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored
delete-mapDeletes a map resource from your AWS account. This action deletes the resource permanently. You cannot undo this action. If the map is being used in an application, the map may not render
delete-place-indexDeletes a Place index resource from your AWS account. This action deletes the resource permanently. You cannot undo this action
delete-trackerDeletes a tracker resource from your AWS account. This action deletes the resource permanently. You can't undo this action. If the tracker resource is in use, you may encounter an error. Make sure that the target resource is not a dependency for your applications
describe-geofence-collectionRetrieves the geofence collection details
describe-mapRetrieves the map resource details
describe-place-indexRetrieves the Place index resource details
describe-trackerRetrieves the tracker resource details
disassociate-tracker-consumerRemoves 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
get-device-positionRetrieves a device's most recent position according to its sample time. Device positions are deleted after one year
get-device-position-historyRetrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after 1 year
get-geofenceRetrieves the geofence details from a geofence collection
get-map-glyphsRetrieves glyphs used to display labels on a map
get-map-spritesRetrieves 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-descriptorRetrieves 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-tileRetrieves 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)
list-geofence-collectionsLists geofence collections in your AWS account
list-geofencesLists geofences stored in a given geofence collection
list-mapsLists map resources in your AWS account
list-place-indexesLists Place index resources in your AWS account
list-tracker-consumersLists geofence collections currently associated to the given tracker resource
list-trackersLists tracker resources in your AWS account
put-geofenceStores 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-positionReverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position. By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service
search-place-index-for-textGeocodes 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. By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service