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

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

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

A batch request to retrieve all device positions.

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.

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

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 functions with geospatial data sourced from your chosen data provider.

Creates a route calculator resource in your AWS account.

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 route calculator resource from your AWS account.

Deletes a tracker resource from your AWS account.

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.

Lists the latest device positions for requested devices.

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 route calculator resources in your AWS account.

Returns the tags for the specified Amazon Location Service resource.

Lists geofence collections currently associated to the given tracker resource.

Lists tracker resources in your AWS 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.

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 Service resource.

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

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.

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

Link to this function

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

View Source

A batch request to retrieve all device positions.

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.

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 30 days before it's deleted.

Link to this function

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

View Source

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

Requires that you first create aroute 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 DepartureNow. This calculates a route based on predictive traffic data at the given time.

You can't specify both DepartureTime and DepartureNow in a single request. Specifying both parameters returns an error message.

  • Specifying a travel mode using TravelMode. This lets you specify additional route preference such as 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_map(client, input, options \\ [])

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

Creates a route calculator resource in your AWS 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.

Link to this function

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

View Source

Creates a tracker resource in your AWS 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 AWS 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_map(client, map_name, input, options \\ [])

View Source

Deletes a map resource from your AWS 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 AWS 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 AWS 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 AWS 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_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, options \\ [])

View Source

Retrieves glyphs used to display labels on a map.

Link to this function

get_map_sprites(client, file_name, map_name, 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, 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, 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

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

View Source

Lists the latest device positions for requested devices.

Link to this function

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

View Source

Lists geofence collections in your AWS 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_maps(client, input, options \\ [])

View Source

Lists map resources in your AWS account.

Link to this function

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

View Source

Lists place index resources in your AWS account.

Link to this function

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

View Source

Lists route calculator resources in your AWS account.

Link to this function

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

View Source

Returns the tags for the specified Amazon Location Service 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 AWS 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_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.

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.

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. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use theTagResourceaction 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 is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 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 Service resource.