Package-level declarations

Types

Link copied to clipboard

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

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

Deletes a batch of geofences from a geofence collection.

Link copied to clipboard

Evaluates device positions against the geofence geometries from a given geofence collection.

Link copied to clipboard

Lists the latest device positions for requested devices.

Link copied to clipboard

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 copied to clipboard

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.

Link copied to clipboard

Calculates a route given the following required parameters: DeparturePosition and DestinationPosition. Requires that you first create a route calculator resource.

Link copied to clipboard

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.

Link copied to clipboard

Creates a geofence collection, which manages and stores geofences.

Link copied to clipboard
inline suspend fun LocationClient.createKey(crossinline block: CreateKeyRequest.Builder.() -> Unit): CreateKeyResponse

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.

Link copied to clipboard
inline suspend fun LocationClient.createMap(crossinline block: CreateMapRequest.Builder.() -> Unit): CreateMapResponse

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Deletes a geofence collection from your Amazon Web Services account.

Link copied to clipboard
inline suspend fun LocationClient.deleteKey(crossinline block: DeleteKeyRequest.Builder.() -> Unit): DeleteKeyResponse

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

Link copied to clipboard
inline suspend fun LocationClient.deleteMap(crossinline block: DeleteMapRequest.Builder.() -> Unit): DeleteMapResponse

Deletes a map resource from your Amazon Web Services account.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Deletes a tracker resource from your Amazon Web Services account.

Link copied to clipboard

Retrieves the geofence collection details.

Link copied to clipboard
inline suspend fun LocationClient.describeKey(crossinline block: DescribeKeyRequest.Builder.() -> Unit): DescribeKeyResponse

Retrieves the API key resource details.

Link copied to clipboard
inline suspend fun LocationClient.describeMap(crossinline block: DescribeMapRequest.Builder.() -> Unit): DescribeMapResponse

Retrieves the map resource details.

Link copied to clipboard

Retrieves the place index resource details.

Link copied to clipboard

Retrieves the route calculator resource details.

Link copied to clipboard

Retrieves the tracker resource details.

Link copied to clipboard

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

Link copied to clipboard

Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts three states for which a device can be in relative to a geofence:

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun LocationClient.getGeofence(crossinline block: GetGeofenceRequest.Builder.() -> Unit): GetGeofenceResponse

Retrieves the geofence details from a geofence collection.

Link copied to clipboard

Retrieves glyphs used to display labels on a map.

Link copied to clipboard

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 copied to clipboard

Retrieves the map style descriptor from a map resource.

Link copied to clipboard
inline suspend fun LocationClient.getMapTile(crossinline block: GetMapTileRequest.Builder.() -> Unit): GetMapTileResponse

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.

Link copied to clipboard
inline suspend fun LocationClient.getPlace(crossinline block: GetPlaceRequest.Builder.() -> Unit): GetPlaceResponse

Finds a place by its unique ID. A PlaceId is returned by other search operations.

Link copied to clipboard

A batch request to retrieve all device positions.

Link copied to clipboard

Lists geofence collections in your Amazon Web Services account.

Link copied to clipboard

Lists geofences stored in a given geofence collection.

Link copied to clipboard
inline suspend fun LocationClient.listKeys(crossinline block: ListKeysRequest.Builder.() -> Unit): ListKeysResponse

Lists API key resources in your Amazon Web Services account.

Link copied to clipboard
inline suspend fun LocationClient.listMaps(crossinline block: ListMapsRequest.Builder.() -> Unit): ListMapsResponse

Lists map resources in your Amazon Web Services account.

Link copied to clipboard

Lists place index resources in your Amazon Web Services account.

Link copied to clipboard

Lists route calculator resources in your Amazon Web Services account.

Link copied to clipboard

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

Link copied to clipboard

Lists geofence collections currently associated to the given tracker resource.

Link copied to clipboard

Lists tracker resources in your Amazon Web Services account.

Link copied to clipboard
inline suspend fun LocationClient.putGeofence(crossinline block: PutGeofenceRequest.Builder.() -> Unit): PutGeofenceResponse

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 copied to clipboard

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 copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun LocationClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.

Link copied to clipboard

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

Link copied to clipboard

Updates the specified properties of a given geofence collection.

Link copied to clipboard
inline suspend fun LocationClient.updateKey(crossinline block: UpdateKeyRequest.Builder.() -> Unit): UpdateKeyResponse

Updates the specified properties of a given API key resource.

Link copied to clipboard
inline suspend fun LocationClient.updateMap(crossinline block: UpdateMapRequest.Builder.() -> Unit): UpdateMapResponse

Updates the specified properties of a given map resource.

Link copied to clipboard

Updates the specified properties of a given place index resource.

Link copied to clipboard

Updates the specified properties for a given route calculator resource.

Link copied to clipboard

Updates the specified properties of a given tracker resource.

Link copied to clipboard

Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.