aws_location
Suite of geospatial services including Maps, Places, Tracking, and Geofencing
Summary
Functions
-
associate_tracker_consumer(Client, TrackerName, Input)
Creates an association between a geofence collection and a tracker resource.
- associate_tracker_consumer(Client, TrackerName, Input0, Options0)
-
batch_delete_geofence(Client, CollectionName, Input)
Deletes a batch of geofences from a geofence collection.
- batch_delete_geofence(Client, CollectionName, Input0, Options0)
-
batch_evaluate_geofences(Client, CollectionName, Input)
Used in geofence monitoring.
- batch_evaluate_geofences(Client, CollectionName, Input0, Options0)
-
batch_get_device_position(Client, TrackerName, Input)
A batch request to retrieve device positions.
- batch_get_device_position(Client, TrackerName, Input0, Options0)
-
batch_put_geofence(Client, CollectionName, Input)
A batch request for storing geofences into a given geofence collection.
- batch_put_geofence(Client, CollectionName, Input0, Options0)
-
batch_update_device_position(Client, TrackerName, Input)
Uploads a position update for one or more devices to a tracker resource.
- batch_update_device_position(Client, TrackerName, Input0, Options0)
-
create_geofence_collection(Client, Input)
Creates a geofence collection, which manages and stores geofences.
- create_geofence_collection(Client, Input0, Options0)
-
create_map(Client, Input)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
- create_map(Client, Input0, Options0)
-
create_place_index(Client, Input)
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
- create_place_index(Client, Input0, Options0)
-
create_tracker(Client, Input)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
- create_tracker(Client, Input0, Options0)
-
delete_geofence_collection(Client, CollectionName, Input)
Deletes a geofence collection from your AWS account.
- delete_geofence_collection(Client, CollectionName, Input0, Options0)
-
delete_map(Client, MapName, Input)
Deletes a map resource from your AWS account.
- delete_map(Client, MapName, Input0, Options0)
-
delete_place_index(Client, IndexName, Input)
Deletes a Place index resource from your AWS account.
- delete_place_index(Client, IndexName, Input0, Options0)
-
delete_tracker(Client, TrackerName, Input)
Deletes a tracker resource from your AWS account.
- delete_tracker(Client, TrackerName, Input0, Options0)
-
describe_geofence_collection(Client, CollectionName)
Retrieves the geofence collection details.
- describe_geofence_collection(Client, CollectionName, QueryMap, HeadersMap)
- describe_geofence_collection(Client, CollectionName, QueryMap, HeadersMap, Options0)
-
describe_map(Client, MapName)
Retrieves the map resource details.
- describe_map(Client, MapName, QueryMap, HeadersMap)
- describe_map(Client, MapName, QueryMap, HeadersMap, Options0)
-
describe_place_index(Client, IndexName)
Retrieves the Place index resource details.
- describe_place_index(Client, IndexName, QueryMap, HeadersMap)
- describe_place_index(Client, IndexName, QueryMap, HeadersMap, Options0)
-
describe_tracker(Client, TrackerName)
Retrieves the tracker resource details.
- describe_tracker(Client, TrackerName, QueryMap, HeadersMap)
- describe_tracker(Client, TrackerName, QueryMap, HeadersMap, Options0)
-
disassociate_tracker_consumer(Client, ConsumerArn, TrackerName, Input)
Removes the association bewteen a tracker resource and a geofence collection.
- disassociate_tracker_consumer(Client, ConsumerArn, TrackerName, Input0, Options0)
-
get_device_position(Client, DeviceId, TrackerName)
Retrieves the latest device position.
- get_device_position(Client, DeviceId, TrackerName, QueryMap, HeadersMap)
- get_device_position(Client, DeviceId, TrackerName, QueryMap, HeadersMap, Options0)
-
get_device_position_history(Client, DeviceId, TrackerName, Input)
Retrieves the device position history from a tracker resource within a specified range of time.
- get_device_position_history(Client, DeviceId, TrackerName, Input0, Options0)
-
get_geofence(Client, CollectionName, GeofenceId)
Retrieves the geofence details from a geofence collection.
- get_geofence(Client, CollectionName, GeofenceId, QueryMap, HeadersMap)
- get_geofence(Client, CollectionName, GeofenceId, QueryMap, HeadersMap, Options0)
-
get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName)
Retrieves glyphs used to display labels on a map.
- get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName, QueryMap, HeadersMap)
- get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName, QueryMap, HeadersMap, Options0)
-
get_map_sprites(Client, FileName, MapName)
Retrieves the sprite sheet corresponding to a map resource.
- get_map_sprites(Client, FileName, MapName, QueryMap, HeadersMap)
- get_map_sprites(Client, FileName, MapName, QueryMap, HeadersMap, Options0)
-
get_map_style_descriptor(Client, MapName)
Retrieves the map style descriptor from a map resource.
- get_map_style_descriptor(Client, MapName, QueryMap, HeadersMap)
- get_map_style_descriptor(Client, MapName, QueryMap, HeadersMap, Options0)
-
get_map_tile(Client, MapName, X, Y, Z)
Retrieves a vector data tile from the map resource.
- get_map_tile(Client, MapName, X, Y, Z, QueryMap, HeadersMap)
- get_map_tile(Client, MapName, X, Y, Z, QueryMap, HeadersMap, Options0)
-
list_geofence_collections(Client, Input)
Lists geofence collections in your AWS account.
- list_geofence_collections(Client, Input0, Options0)
-
list_geofences(Client, CollectionName, Input)
Lists geofences stored in a given geofence collection.
- list_geofences(Client, CollectionName, Input0, Options0)
-
list_maps(Client, Input)
Lists map resources in your AWS account.
- list_maps(Client, Input0, Options0)
-
list_place_indexes(Client, Input)
Lists Place index resources in your AWS account.
- list_place_indexes(Client, Input0, Options0)
-
list_tracker_consumers(Client, TrackerName, Input)
Lists geofence collections currently associated to the given tracker resource.
- list_tracker_consumers(Client, TrackerName, Input0, Options0)
-
list_trackers(Client, Input)
Lists tracker resources in your AWS account.
- list_trackers(Client, Input0, Options0)
-
put_geofence(Client, CollectionName, GeofenceId, Input)
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.
- put_geofence(Client, CollectionName, GeofenceId, Input0, Options0)
-
search_place_index_for_position(Client, IndexName, Input)
Reverse geocodes a given coordinate and returns a legible address.
- search_place_index_for_position(Client, IndexName, Input0, Options0)
-
search_place_index_for_text(Client, IndexName, Input)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
- search_place_index_for_text(Client, IndexName, Input0, Options0)
Functions
associate_tracker_consumer(Client, TrackerName, Input)
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.associate_tracker_consumer(Client, TrackerName, Input0, Options0)
batch_delete_geofence(Client, CollectionName, Input)
Deletes a batch of geofences from a geofence collection.
This action deletes the resource permanently. You can't undo this action.batch_delete_geofence(Client, CollectionName, Input0, Options0)
batch_evaluate_geofences(Client, CollectionName, Input)
Used in geofence monitoring.
Evaluates device positions against the position of geofences in a given geofence collection.batch_evaluate_geofences(Client, CollectionName, Input0, Options0)
batch_get_device_position(Client, TrackerName, Input)
A batch request to retrieve device positions.
The response will return the device positions from the last 24 hours.batch_get_device_position(Client, TrackerName, Input0, Options0)
batch_put_geofence(Client, CollectionName, Input)
A batch request for storing geofences into a given geofence collection.
batch_put_geofence(Client, CollectionName, Input0, Options0)
batch_update_device_position(Client, TrackerName, Input)
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.
Limitation — Location data is sampled at a fixed rate of 1 position per 30 second interval, and retained for 1 year before it is deleted.batch_update_device_position(Client, TrackerName, Input0, Options0)
create_geofence_collection(Client, Input)
Creates a geofence collection, which manages and stores geofences.
create_geofence_collection(Client, Input0, Options0)
create_map(Client, Input)
Creates 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_map(Client, Input0, Options0)
create_place_index(Client, Input)
Creates 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_place_index(Client, Input0, Options0)
create_tracker(Client, Input)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
create_tracker(Client, Input0, Options0)
delete_geofence_collection(Client, CollectionName, Input)
Deletes 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_geofence_collection(Client, CollectionName, Input0, Options0)
delete_map(Client, MapName, Input)
Deletes 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_map(Client, MapName, Input0, Options0)
delete_place_index(Client, IndexName, Input)
Deletes a Place index resource from your AWS account.
This action deletes the resource permanently. You cannot undo this action.delete_place_index(Client, IndexName, Input0, Options0)
delete_tracker(Client, TrackerName, Input)
Deletes 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.delete_tracker(Client, TrackerName, Input0, Options0)
describe_geofence_collection(Client, CollectionName)
Retrieves the geofence collection details.
describe_geofence_collection(Client, CollectionName, QueryMap, HeadersMap)
describe_geofence_collection(Client, CollectionName, QueryMap, HeadersMap, Options0)
describe_map(Client, MapName)
Retrieves the map resource details.
describe_map(Client, MapName, QueryMap, HeadersMap)
describe_map(Client, MapName, QueryMap, HeadersMap, Options0)
describe_place_index(Client, IndexName)
Retrieves the Place index resource details.
describe_place_index(Client, IndexName, QueryMap, HeadersMap)
describe_place_index(Client, IndexName, QueryMap, HeadersMap, Options0)
describe_tracker(Client, TrackerName)
Retrieves the tracker resource details.
describe_tracker(Client, TrackerName, QueryMap, HeadersMap)
describe_tracker(Client, TrackerName, QueryMap, HeadersMap, Options0)
disassociate_tracker_consumer(Client, ConsumerArn, TrackerName, Input)
Removes the association bewteen 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.disassociate_tracker_consumer(Client, ConsumerArn, TrackerName, Input0, Options0)
get_device_position(Client, DeviceId, TrackerName)
Retrieves the latest device position.
Limitation — Device positions are deleted after one year.get_device_position(Client, DeviceId, TrackerName, QueryMap, HeadersMap)
get_device_position(Client, DeviceId, TrackerName, QueryMap, HeadersMap, Options0)
get_device_position_history(Client, DeviceId, TrackerName, Input)
Retrieves the device position history from a tracker resource within a specified range of time.
Limitation — Device positions are deleted after one year.get_device_position_history(Client, DeviceId, TrackerName, Input0, Options0)
get_geofence(Client, CollectionName, GeofenceId)
Retrieves the geofence details from a geofence collection.
get_geofence(Client, CollectionName, GeofenceId, QueryMap, HeadersMap)
get_geofence(Client, CollectionName, GeofenceId, QueryMap, HeadersMap, Options0)
get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName)
Retrieves glyphs used to display labels on a map.
get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName, QueryMap, HeadersMap)
get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName, QueryMap, HeadersMap, Options0)
get_map_sprites(Client, FileName, MapName)
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_sprites(Client, FileName, MapName, QueryMap, HeadersMap)
get_map_sprites(Client, FileName, MapName, QueryMap, HeadersMap, Options0)
get_map_style_descriptor(Client, MapName)
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_style_descriptor(Client, MapName, QueryMap, HeadersMap)
get_map_style_descriptor(Client, MapName, QueryMap, HeadersMap, Options0)
get_map_tile(Client, MapName, X, Y, Z)
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).get_map_tile(Client, MapName, X, Y, Z, QueryMap, HeadersMap)
get_map_tile(Client, MapName, X, Y, Z, QueryMap, HeadersMap, Options0)
list_geofence_collections(Client, Input)
Lists geofence collections in your AWS account.
list_geofence_collections(Client, Input0, Options0)
list_geofences(Client, CollectionName, Input)
Lists geofences stored in a given geofence collection.
list_geofences(Client, CollectionName, Input0, Options0)
list_maps(Client, Input)
Lists map resources in your AWS account.
list_maps(Client, Input0, Options0)
list_place_indexes(Client, Input)
Lists Place index resources in your AWS account.
list_place_indexes(Client, Input0, Options0)
list_tracker_consumers(Client, TrackerName, Input)
Lists geofence collections currently associated to the given tracker resource.
list_tracker_consumers(Client, TrackerName, Input0, Options0)
list_trackers(Client, Input)
Lists tracker resources in your AWS account.
list_trackers(Client, Input0, Options0)
put_geofence(Client, CollectionName, GeofenceId, Input)
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.
put_geofence(Client, CollectionName, GeofenceId, Input0, Options0)
search_place_index_for_position(Client, IndexName, Input)
Reverse 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_position(Client, IndexName, Input0, Options0)
search_place_index_for_text(Client, IndexName, Input)
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.
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 theStorage
option for the
IntendedUse
parameter when requesting Places in Japan. For more
information, see the AWS Service Terms for Amazon Location Service.