View Source AWS.Location (aws-elixir v0.14.1)

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

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).

Calculates a route given the following required parameters: DeparturePosition and DestinationPosition.

Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions.

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.

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

Creates a place index resource in your Amazon Web Services account.

Creates a route calculator resource in your Amazon Web Services account.

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 a map resource from your Amazon Web Services account.

Deletes a place index resource from your Amazon Web Services account.

Deletes a route calculator resource from your Amazon Web Services account.

Deletes a tracker resource from your Amazon Web Services account.

Retrieves the API key resource details.

Retrieves the map resource details.

Retrieves the place index resource details.

Retrieves the route calculator resource details.

Retrieves the tracker resource details.

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

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.

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.

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.

Lists map resources in your Amazon Web Services account.

Lists place index resources in your Amazon Web Services account.

Lists route calculator resources in your Amazon Web Services account.

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.

Reverse geocodes a given coordinate and returns a legible address.

Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.

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

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.

Updates the specified properties of a given map resource.

Updates the specified properties of a given place index resource.

Updates the specified properties for a given route calculator resource.

Updates the specified properties of a given tracker resource.

Functions

Link to this function

associate_tracker_consumer(client, tracker_name, input, options \\ [])

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.

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.

Link to this function

batch_delete_device_position_history(client, tracker_name, input, options \\ [])

View Source

Deletes the position history of one or more devices from a tracker resource.

Link to this function

batch_delete_geofence(client, collection_name, input, options \\ [])

View Source

Deletes a batch of geofences from a geofence collection.

This operation deletes the resource permanently.

Link to this function

batch_evaluate_geofences(client, collection_name, input, options \\ [])

View Source

Evaluates 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:

  • ENTER if Amazon Location determines that the tracked device has entered a geofenced area.

  • EXIT if 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.

Link to this function

batch_get_device_position(client, tracker_name, input, options \\ [])

View Source

Lists the latest device positions for requested devices.

Link to this function

batch_put_geofence(client, collection_name, input, options \\ [])

View Source

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.

Link to this function

batch_update_device_position(client, tracker_name, input, options \\ [])

View Source

Uploads 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.

Link to this function

calculate_route(client, calculator_name, input, options \\ [])

View Source

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 DepartureTime or DepartNow. 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 CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.

If you specify walking for the travel mode and your data provider is Esri, the start and destination must be within 40km.

Link to this function

calculate_route_matrix(client, calculator_name, input, options \\ [])

View Source

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 DepartureTime or DepartNow. 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 CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
Link to this function

create_geofence_collection(client, input, options \\ [])

View Source

Creates a geofence collection, which manages and stores geofences.

Link to this function

create_key(client, input, options \\ [])

View Source

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 Using API keys.

Link to this function

create_map(client, input, options \\ [])

View Source

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.

Link to this function

create_place_index(client, input, options \\ [])

View Source

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.

Link to this function

create_route_calculator(client, input, options \\ [])

View Source

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.

Link to this function

create_tracker(client, input, options \\ [])

View Source

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

Link to this function

delete_geofence_collection(client, collection_name, input, options \\ [])

View Source

Deletes 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.

Link to this function

delete_key(client, key_name, input, options \\ [])

View Source

Deletes the specified API key.

The API key must have been deactivated more than 90 days previously.

Link to this function

delete_map(client, map_name, input, options \\ [])

View Source

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.

Link to this function

delete_place_index(client, index_name, input, options \\ [])

View Source

Deletes a place index resource from your Amazon Web Services account.

This operation deletes the resource permanently.

Link to this function

delete_route_calculator(client, calculator_name, input, options \\ [])

View Source

Deletes a route calculator resource from your Amazon Web Services account.

This operation deletes the resource permanently.

Link to this function

delete_tracker(client, tracker_name, input, options \\ [])

View Source

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.

Link to this function

describe_geofence_collection(client, collection_name, options \\ [])

View Source

Retrieves the geofence collection details.

Link to this function

describe_key(client, key_name, options \\ [])

View Source

Retrieves the API key resource details.

Link to this function

describe_map(client, map_name, options \\ [])

View Source

Retrieves the map resource details.

Link to this function

describe_place_index(client, index_name, options \\ [])

View Source

Retrieves the place index resource details.

Link to this function

describe_route_calculator(client, calculator_name, options \\ [])

View Source

Retrieves the route calculator resource details.

Link to this function

describe_tracker(client, tracker_name, options \\ [])

View Source

Retrieves the tracker resource details.

Link to this function

disassociate_tracker_consumer(client, consumer_arn, tracker_name, input, options \\ [])

View Source

Removes 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.

Link to this function

get_device_position(client, device_id, tracker_name, options \\ [])

View Source

Retrieves a device's most recent position according to its sample time.

Device positions are deleted after 30 days.

Link to this function

get_device_position_history(client, device_id, tracker_name, input, options \\ [])

View Source

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

Device positions are deleted after 30 days.

Link to this function

get_geofence(client, collection_name, geofence_id, options \\ [])

View Source

Retrieves the geofence details from a geofence collection.

Link to this function

get_map_glyphs(client, font_stack, font_unicode_range, map_name, key \\ nil, options \\ [])

View Source

Retrieves glyphs used to display labels on a map.

Link to this function

get_map_sprites(client, file_name, map_name, key \\ nil, options \\ [])

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_style_descriptor(client, map_name, key \\ nil, options \\ [])

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_tile(client, map_name, x, y, z, key \\ nil, options \\ [])

View Source

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).

Link to this function

get_place(client, index_name, place_id, key \\ nil, language \\ nil, options \\ [])

View Source

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

Link to this function

list_device_positions(client, tracker_name, input, options \\ [])

View Source

A batch request to retrieve all device positions.

Link to this function

list_geofence_collections(client, input, options \\ [])

View Source

Lists geofence collections in your Amazon Web Services account.

Link to this function

list_geofences(client, collection_name, input, options \\ [])

View Source

Lists geofences stored in a given geofence collection.

Link to this function

list_keys(client, input, options \\ [])

View Source

Lists API key resources in your Amazon Web Services account.

Link to this function

list_maps(client, input, options \\ [])

View Source

Lists map resources in your Amazon Web Services account.

Link to this function

list_place_indexes(client, input, options \\ [])

View Source

Lists place index resources in your Amazon Web Services account.

Link to this function

list_route_calculators(client, input, options \\ [])

View Source

Lists route calculator resources in your Amazon Web Services account.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns a list of tags that are applied to the specified Amazon Location resource.

Link to this function

list_tracker_consumers(client, tracker_name, input, options \\ [])

View Source

Lists geofence collections currently associated to the given tracker resource.

Link to this function

list_trackers(client, input, options \\ [])

View Source

Lists tracker resources in your Amazon Web Services account.

Link to this function

put_geofence(client, collection_name, geofence_id, input, options \\ [])

View Source

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.

Link to this function

search_place_index_for_position(client, index_name, input, options \\ [])

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.

Link to this function

search_place_index_for_suggestions(client, index_name, input, options \\ [])

View Source

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.

Link to this function

search_place_index_for_text(client, index_name, input, options \\ [])

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.

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.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes one or more tags from the specified Amazon Location resource.

Link to this function

update_geofence_collection(client, collection_name, input, options \\ [])

View Source

Updates the specified properties of a given geofence collection.

Link to this function

update_key(client, key_name, input, options \\ [])

View Source

Updates the specified properties of a given API key resource.

Link to this function

update_map(client, map_name, input, options \\ [])

View Source

Updates the specified properties of a given map resource.

Link to this function

update_place_index(client, index_name, input, options \\ [])

View Source

Updates the specified properties of a given place index resource.

Link to this function

update_route_calculator(client, calculator_name, input, options \\ [])

View Source

Updates the specified properties for a given route calculator resource.

Link to this function

update_tracker(client, tracker_name, input, options \\ [])

View Source

Updates the specified properties of a given tracker resource.