View Source aws_location (aws v0.3.1)

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

Link to this section Summary

Functions

Creates an association between a geofence collection and a tracker resource.

Deletes a batch of geofences from a geofence collection.

A batch request to retrieve device positions.

A batch request for storing geofences into a given geofence collection.

Uploads a position update for one or more devices to a tracker resource.

Creates a geofence collection, which manages and stores geofences.

Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.

Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.

Deletes a geofence collection from your AWS account.

Deletes a map resource from your AWS account.

Deletes a Place index resource from your AWS account.

Deletes a tracker resource from your AWS account.

Retrieves the geofence collection details.
Retrieves the map resource details.
Retrieves the Place index resource details.
Retrieves the tracker resource details.

Removes the association bewteen a tracker resource and a geofence collection.

Retrieves the latest device position.

Retrieves the device position history from a tracker resource within a specified range of time.

Retrieves the geofence details from a geofence collection.
Retrieves glyphs used to display labels on a map.

Retrieves the sprite sheet corresponding to a map resource.

Retrieves the map style descriptor from a map resource.

Retrieves a vector data tile from the map resource.

Lists geofence collections in your AWS account.
Lists geofences stored in a given geofence collection.
Lists map resources in your AWS account.
Lists Place index resources in your AWS account.
Lists geofence collections currently associated to the given tracker resource.
Lists tracker resources in your AWS account.
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.

Reverse geocodes a given coordinate and returns a legible address.

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Link to this section Functions

Link to this function

associate_tracker_consumer(Client, TrackerName, Input)

View Source

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.
Link to this function

associate_tracker_consumer(Client, TrackerName, Input0, Options0)

View Source
Link to this function

batch_delete_geofence(Client, CollectionName, Input)

View Source

Deletes a batch of geofences from a geofence collection.

This action deletes the resource permanently. You can't undo this action.
Link to this function

batch_delete_geofence(Client, CollectionName, Input0, Options0)

View Source
Link to this function

batch_evaluate_geofences(Client, CollectionName, Input)

View Source

Used in geofence monitoring.

Evaluates device positions against the position of geofences in a given geofence collection.
Link to this function

batch_evaluate_geofences(Client, CollectionName, Input0, Options0)

View Source
Link to this function

batch_get_device_position(Client, TrackerName, Input)

View Source

A batch request to retrieve device positions.

The response will return the device positions from the last 24 hours.
Link to this function

batch_get_device_position(Client, TrackerName, Input0, Options0)

View Source
Link to this function

batch_put_geofence(Client, CollectionName, Input)

View Source
A batch request for storing geofences into a given geofence collection.
Link to this function

batch_put_geofence(Client, CollectionName, Input0, Options0)

View Source
Link to this function

batch_update_device_position(Client, TrackerName, Input)

View Source

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.
Link to this function

batch_update_device_position(Client, TrackerName, Input0, Options0)

View Source
Link to this function

create_geofence_collection(Client, Input)

View Source
Creates a geofence collection, which manages and stores geofences.
Link to this function

create_geofence_collection(Client, Input0, Options0)

View Source
Link to this function

create_map(Client, Input)

View Source

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.
Link to this function

create_map(Client, Input0, Options0)

View Source
Link to this function

create_place_index(Client, Input)

View Source

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.
Link to this function

create_place_index(Client, Input0, Options0)

View Source
Link to this function

create_tracker(Client, Input)

View Source
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
Link to this function

create_tracker(Client, Input0, Options0)

View Source
Link to this function

delete_geofence_collection(Client, CollectionName, Input)

View Source

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.
Link to this function

delete_geofence_collection(Client, CollectionName, Input0, Options0)

View Source
Link to this function

delete_map(Client, MapName, Input)

View Source

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.
Link to this function

delete_map(Client, MapName, Input0, Options0)

View Source
Link to this function

delete_place_index(Client, IndexName, Input)

View Source

Deletes a Place index resource from your AWS account.

This action deletes the resource permanently. You cannot undo this action.
Link to this function

delete_place_index(Client, IndexName, Input0, Options0)

View Source
Link to this function

delete_tracker(Client, TrackerName, Input)

View Source

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.
Link to this function

delete_tracker(Client, TrackerName, Input0, Options0)

View Source
Link to this function

describe_geofence_collection(Client, CollectionName)

View Source
Retrieves the geofence collection details.
Link to this function

describe_geofence_collection(Client, CollectionName, QueryMap, HeadersMap)

View Source
Link to this function

describe_geofence_collection(Client, CollectionName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_map(Client, MapName)

View Source
Retrieves the map resource details.
Link to this function

describe_map(Client, MapName, QueryMap, HeadersMap)

View Source
Link to this function

describe_map(Client, MapName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_place_index(Client, IndexName)

View Source
Retrieves the Place index resource details.
Link to this function

describe_place_index(Client, IndexName, QueryMap, HeadersMap)

View Source
Link to this function

describe_place_index(Client, IndexName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_tracker(Client, TrackerName)

View Source
Retrieves the tracker resource details.
Link to this function

describe_tracker(Client, TrackerName, QueryMap, HeadersMap)

View Source
Link to this function

describe_tracker(Client, TrackerName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

disassociate_tracker_consumer(Client, ConsumerArn, TrackerName, Input)

View Source

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.
Link to this function

disassociate_tracker_consumer(Client, ConsumerArn, TrackerName, Input0, Options0)

View Source
Link to this function

get_device_position(Client, DeviceId, TrackerName)

View Source

Retrieves the latest device position.

Limitation — Device positions are deleted after one year.
Link to this function

get_device_position(Client, DeviceId, TrackerName, QueryMap, HeadersMap)

View Source
Link to this function

get_device_position(Client, DeviceId, TrackerName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_device_position_history(Client, DeviceId, TrackerName, Input)

View Source

Retrieves the device position history from a tracker resource within a specified range of time.

Limitation — Device positions are deleted after one year.
Link to this function

get_device_position_history(Client, DeviceId, TrackerName, Input0, Options0)

View Source
Link to this function

get_geofence(Client, CollectionName, GeofenceId)

View Source
Retrieves the geofence details from a geofence collection.
Link to this function

get_geofence(Client, CollectionName, GeofenceId, QueryMap, HeadersMap)

View Source
Link to this function

get_geofence(Client, CollectionName, GeofenceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName)

View Source
Retrieves glyphs used to display labels on a map.
Link to this function

get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName, QueryMap, HeadersMap)

View Source
Link to this function

get_map_glyphs(Client, FontStack, FontUnicodeRange, MapName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_map_sprites(Client, FileName, MapName)

View Source

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.
Link to this function

get_map_sprites(Client, FileName, MapName, QueryMap, HeadersMap)

View Source
Link to this function

get_map_sprites(Client, FileName, MapName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_map_style_descriptor(Client, MapName)

View Source

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.
Link to this function

get_map_style_descriptor(Client, MapName, QueryMap, HeadersMap)

View Source
Link to this function

get_map_style_descriptor(Client, MapName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_map_tile(Client, MapName, X, Y, Z)

View Source

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).
Link to this function

get_map_tile(Client, MapName, X, Y, Z, QueryMap, HeadersMap)

View Source
Link to this function

get_map_tile(Client, MapName, X, Y, Z, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_geofence_collections(Client, Input)

View Source
Lists geofence collections in your AWS account.
Link to this function

list_geofence_collections(Client, Input0, Options0)

View Source
Link to this function

list_geofences(Client, CollectionName, Input)

View Source
Lists geofences stored in a given geofence collection.
Link to this function

list_geofences(Client, CollectionName, Input0, Options0)

View Source
Link to this function

list_maps(Client, Input)

View Source
Lists map resources in your AWS account.
Link to this function

list_maps(Client, Input0, Options0)

View Source
Link to this function

list_place_indexes(Client, Input)

View Source
Lists Place index resources in your AWS account.
Link to this function

list_place_indexes(Client, Input0, Options0)

View Source
Link to this function

list_tracker_consumers(Client, TrackerName, Input)

View Source
Lists geofence collections currently associated to the given tracker resource.
Link to this function

list_tracker_consumers(Client, TrackerName, Input0, Options0)

View Source
Link to this function

list_trackers(Client, Input)

View Source
Lists tracker resources in your AWS account.
Link to this function

list_trackers(Client, Input0, Options0)

View Source
Link to this function

put_geofence(Client, CollectionName, GeofenceId, Input)

View Source
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.
Link to this function

put_geofence(Client, CollectionName, GeofenceId, Input0, Options0)

View Source
Link to this function

search_place_index_for_position(Client, IndexName, Input)

View Source

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.
Link to this function

search_place_index_for_position(Client, IndexName, Input0, Options0)

View Source
Link to this function

search_place_index_for_text(Client, IndexName, Input)

View Source

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 the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
Link to this function

search_place_index_for_text(Client, IndexName, Input0, Options0)

View Source