LocationClient

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

Properties

Link copied to clipboard
abstract override val config: LocationClient.Config

LocationClient's configuration

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

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to CalculateRoutes/location/latest/APIReference/API_CalculateRoutes.html or CalculateIsolines/location/latest/APIReference/API_CalculateIsolines.html unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the CalculateRouteMatrix/location/latest/APIReference/API_CalculateRouteMatrix.html unless you require Grab data.

Link copied to clipboard

Creates a geofence collection, which manages and stores geofences.

Link copied to clipboard
abstract suspend fun createKey(input: CreateKeyRequest): 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
abstract suspend fun createMap(input: CreateMapRequest): CreateMapResponse

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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
abstract suspend fun deleteKey(input: DeleteKeyRequest): DeleteKeyResponse

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

Link copied to clipboard
abstract suspend fun deleteMap(input: DeleteMapRequest): DeleteMapResponse

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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
abstract suspend fun describeKey(input: DescribeKeyRequest): DescribeKeyResponse

Retrieves the API key resource details.

Link copied to clipboard
abstract suspend fun describeMap(input: DescribeMapRequest): DescribeMapResponse

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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

This action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed. Each forecasted event is associated with a geofence from a provided geofence collection. A forecast event can have one of the following states:

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
abstract suspend fun getGeofence(input: GetGeofenceRequest): GetGeofenceResponse

Retrieves the geofence details from a geofence collection.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetGlyphs unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetSprites unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetStyleDescriptor unless you require Grab data.

Link copied to clipboard
abstract suspend fun getMapTile(input: GetMapTileRequest): GetMapTileResponse

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetTile unless you require Grab data.

Link copied to clipboard
abstract suspend fun getPlace(input: GetPlaceRequest): GetPlaceResponse

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the GetPlace/location/latest/APIReference/API_geoplaces_GetPlace.html operation unless you require Grab data.

Link copied to clipboard

A batch request to retrieve all device positions.

Link copied to clipboard
abstract suspend fun listGeofenceCollections(input: ListGeofenceCollectionsRequest = ListGeofenceCollectionsRequest { }): ListGeofenceCollectionsResponse

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
abstract suspend fun listKeys(input: ListKeysRequest = ListKeysRequest { }): ListKeysResponse

Lists API key resources in your Amazon Web Services account.

Link copied to clipboard
abstract suspend fun listMaps(input: ListMapsRequest = ListMapsRequest { }): ListMapsResponse

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard
abstract suspend fun listPlaceIndexes(input: ListPlaceIndexesRequest = ListPlaceIndexesRequest { }): ListPlaceIndexesResponse

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard
abstract suspend fun listRouteCalculators(input: ListRouteCalculatorsRequest = ListRouteCalculatorsRequest { }): ListRouteCalculatorsResponse

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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
abstract suspend fun listTrackers(input: ListTrackersRequest = ListTrackersRequest { }): ListTrackersResponse

Lists tracker resources in your Amazon Web Services account.

Link copied to clipboard
abstract suspend fun putGeofence(input: PutGeofenceRequest): 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

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to ReverseGeocode/location/latest/APIReference/API_geoplaces_ReverseGeocode.html or SearchNearby/location/latest/APIReference/API_geoplaces_SearchNearby.html unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to Suggest/location/latest/APIReference/API_geoplaces_Suggest.html or Autocomplete/location/latest/APIReference/API_geoplaces_Autocomplete.html unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to Geocode/location/latest/APIReference/API_geoplaces_Geocode.html or SearchText/location/latest/APIReference/API_geoplaces_SearchText.html unless you require Grab data.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): 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
abstract suspend fun updateKey(input: UpdateKeyRequest): UpdateKeyResponse

Updates the specified properties of a given API key resource.

Link copied to clipboard
abstract suspend fun updateMap(input: UpdateMapRequest): UpdateMapResponse

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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.

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

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to CalculateRoutes/location/latest/APIReference/API_CalculateRoutes.html or CalculateIsolines/location/latest/APIReference/API_CalculateIsolines.html unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the CalculateRouteMatrix/location/latest/APIReference/API_CalculateRouteMatrix.html unless you require Grab data.

Link copied to clipboard
expect abstract fun close()
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

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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

This action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed. Each forecasted event is associated with a geofence from a provided geofence collection. A forecast event can have one of the following states:

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

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetGlyphs unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetSprites unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetStyleDescriptor unless you require Grab data.

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

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetTile unless you require Grab data.

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

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the GetPlace/location/latest/APIReference/API_geoplaces_GetPlace.html operation unless you require Grab data.

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
fun LocationClient.listKeysPaginated(initialRequest: ListKeysRequest = ListKeysRequest { }): Flow<ListKeysResponse>

Paginate over ListKeysResponse results.

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

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard
fun LocationClient.listMapsPaginated(initialRequest: ListMapsRequest = ListMapsRequest { }): Flow<ListMapsResponse>

Paginate over ListMapsResponse results.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to ReverseGeocode/location/latest/APIReference/API_geoplaces_ReverseGeocode.html or SearchNearby/location/latest/APIReference/API_geoplaces_SearchNearby.html unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to Suggest/location/latest/APIReference/API_geoplaces_Suggest.html or Autocomplete/location/latest/APIReference/API_geoplaces_Autocomplete.html unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to Geocode/location/latest/APIReference/API_geoplaces_Geocode.html or SearchText/location/latest/APIReference/API_geoplaces_SearchText.html unless you require Grab data.

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

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Link copied to clipboard

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

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.