AmazonLocation (AWS SDK for Java

All Known Subinterfaces:

AmazonLocationAsync

All Known Implementing Classes:

AbstractAmazonLocation, AbstractAmazonLocationAsync, AmazonLocationAsyncClient, AmazonLocationClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLocation
```
Interface for accessing Amazon Location Service.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonLocation instead.

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

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateTrackerConsumerResult`	`associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)` Creates an association between a geofence collection and a tracker resource.
`BatchDeleteGeofenceResult`	`batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)` Deletes a batch of geofences from a geofence collection.
`BatchEvaluateGeofencesResult`	`batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)` Used in geofence monitoring.
`BatchGetDevicePositionResult`	`batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)` A batch request to retrieve device positions.
`BatchPutGeofenceResult`	`batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)` A batch request for storing geofences into a given geofence collection.
`BatchUpdateDevicePositionResult`	`batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)` Uploads a position update for one or more devices to a tracker resource.
`CreateGeofenceCollectionResult`	`createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)` Creates a geofence collection, which manages and stores geofences.
`CreateMapResult`	`createMap(CreateMapRequest createMapRequest)` Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
`CreatePlaceIndexResult`	`createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)` Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
`CreateTrackerResult`	`createTracker(CreateTrackerRequest createTrackerRequest)` Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
`DeleteGeofenceCollectionResult`	`deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)` Deletes a geofence collection from your AWS account.
`DeleteMapResult`	`deleteMap(DeleteMapRequest deleteMapRequest)` Deletes a map resource from your AWS account.
`DeletePlaceIndexResult`	`deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)` Deletes a Place index resource from your AWS account.
`DeleteTrackerResult`	`deleteTracker(DeleteTrackerRequest deleteTrackerRequest)` Deletes a tracker resource from your AWS account.
`DescribeGeofenceCollectionResult`	`describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)` Retrieves the geofence collection details.
`DescribeMapResult`	`describeMap(DescribeMapRequest describeMapRequest)` Retrieves the map resource details.
`DescribePlaceIndexResult`	`describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)` Retrieves the Place index resource details.
`DescribeTrackerResult`	`describeTracker(DescribeTrackerRequest describeTrackerRequest)` Retrieves the tracker resource details.
`DisassociateTrackerConsumerResult`	`disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)` Removes the association bewteen a tracker resource and a geofence collection.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDevicePositionResult`	`getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)` Retrieves the latest device position.
`GetDevicePositionHistoryResult`	`getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)` Retrieves the device position history from a tracker resource within a specified range of time.
`GetGeofenceResult`	`getGeofence(GetGeofenceRequest getGeofenceRequest)` Retrieves the geofence details from a geofence collection.
`GetMapGlyphsResult`	`getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)` Retrieves glyphs used to display labels on a map.
`GetMapSpritesResult`	`getMapSprites(GetMapSpritesRequest getMapSpritesRequest)` Retrieves the sprite sheet corresponding to a map resource.
`GetMapStyleDescriptorResult`	`getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)` Retrieves the map style descriptor from a map resource.
`GetMapTileResult`	`getMapTile(GetMapTileRequest getMapTileRequest)` Retrieves a vector data tile from the map resource.
`ListGeofenceCollectionsResult`	`listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)` Lists geofence collections in your AWS account.
`ListGeofencesResult`	`listGeofences(ListGeofencesRequest listGeofencesRequest)` Lists geofences stored in a given geofence collection.
`ListMapsResult`	`listMaps(ListMapsRequest listMapsRequest)` Lists map resources in your AWS account.
`ListPlaceIndexesResult`	`listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)` Lists Place index resources in your AWS account.
`ListTrackerConsumersResult`	`listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)` Lists geofence collections currently associated to the given tracker resource.
`ListTrackersResult`	`listTrackers(ListTrackersRequest listTrackersRequest)` Lists tracker resources in your AWS account.
`PutGeofenceResult`	`putGeofence(PutGeofenceRequest putGeofenceRequest)` 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.
`SearchPlaceIndexForPositionResult`	`searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)` Reverse geocodes a given coordinate and returns a legible address.
`SearchPlaceIndexForTextResult`	`searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)` Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - associateTrackerConsumer
```
AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)
```
    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.
    
    Parameters:
    
    associateTrackerConsumerRequest -
    
    Returns:
    
    Result of the AssociateTrackerConsumer operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    ConflictException - The request was unsuccessful due to a conflict.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - batchDeleteGeofence
```
BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
```
    Deletes a batch of geofences from a geofence collection.
    
    This action deletes the resource permanently. You can't undo this action.
    
    Parameters:
    
    batchDeleteGeofenceRequest -
    
    Returns:
    
    Result of the BatchDeleteGeofence operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - batchEvaluateGeofences
```
BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
```
    Used in geofence monitoring. Evaluates device positions against the position of geofences in a given geofence collection.
    
    Parameters:
    
    batchEvaluateGeofencesRequest -
    
    Returns:
    
    Result of the BatchEvaluateGeofences operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - batchGetDevicePosition
```
BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
```
    A batch request to retrieve device positions.
    
    The response will return the device positions from the last 24 hours.
    
    Parameters:
    
    batchGetDevicePositionRequest -
    
    Returns:
    
    Result of the BatchGetDevicePosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - batchPutGeofence
```
BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)
```
    A batch request for storing geofences into a given geofence collection.
    
    Parameters:
    
    batchPutGeofenceRequest -
    
    Returns:
    
    Result of the BatchPutGeofence operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - batchUpdateDevicePosition
```
BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)
```
    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.
    
    Parameters:
    
    batchUpdateDevicePositionRequest -
    
    Returns:
    
    Result of the BatchUpdateDevicePosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createGeofenceCollection
```
CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)
```
    Creates a geofence collection, which manages and stores geofences.
    
    Parameters:
    
    createGeofenceCollectionRequest -
    
    Returns:
    
    Result of the CreateGeofenceCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful due to a conflict.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createMap
```
CreateMapResult createMap(CreateMapRequest createMapRequest)
```
    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.
    
    Parameters:
    
    createMapRequest -
    
    Returns:
    
    Result of the CreateMap operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful due to a conflict.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createPlaceIndex
```
CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
```
    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.
    
    Parameters:
    
    createPlaceIndexRequest -
    
    Returns:
    
    Result of the CreatePlaceIndex operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful due to a conflict.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - createTracker
```
CreateTrackerResult createTracker(CreateTrackerRequest createTrackerRequest)
```
    Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
    
    Parameters:
    
    createTrackerRequest -
    
    Returns:
    
    Result of the CreateTracker operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful due to a conflict.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteGeofenceCollection
```
DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)
```
    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.
    
    Parameters:
    
    deleteGeofenceCollectionRequest -
    
    Returns:
    
    Result of the DeleteGeofenceCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteMap
```
DeleteMapResult deleteMap(DeleteMapRequest deleteMapRequest)
```
    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.
    
    Parameters:
    
    deleteMapRequest -
    
    Returns:
    
    Result of the DeleteMap operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deletePlaceIndex
```
DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
```
    Deletes a Place index resource from your AWS account.
    
    This action deletes the resource permanently. You cannot undo this action.
    
    Parameters:
    
    deletePlaceIndexRequest -
    
    Returns:
    
    Result of the DeletePlaceIndex operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - deleteTracker
```
DeleteTrackerResult deleteTracker(DeleteTrackerRequest deleteTrackerRequest)
```
    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.
    
    Parameters:
    
    deleteTrackerRequest -
    
    Returns:
    
    Result of the DeleteTracker operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - describeGeofenceCollection
```
DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)
```
    Retrieves the geofence collection details.
    
    Parameters:
    
    describeGeofenceCollectionRequest -
    
    Returns:
    
    Result of the DescribeGeofenceCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - describeMap
```
DescribeMapResult describeMap(DescribeMapRequest describeMapRequest)
```
    Retrieves the map resource details.
    
    Parameters:
    
    describeMapRequest -
    
    Returns:
    
    Result of the DescribeMap operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - describePlaceIndex
```
DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
```
    Retrieves the Place index resource details.
    
    Parameters:
    
    describePlaceIndexRequest -
    
    Returns:
    
    Result of the DescribePlaceIndex operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - describeTracker
```
DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrackerRequest)
```
    Retrieves the tracker resource details.
    
    Parameters:
    
    describeTrackerRequest -
    
    Returns:
    
    Result of the DescribeTracker operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - disassociateTrackerConsumer
```
DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)
```
    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.
    
    Parameters:
    
    disassociateTrackerConsumerRequest -
    
    Returns:
    
    Result of the DisassociateTrackerConsumer operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getDevicePosition
```
GetDevicePositionResult getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
```
    Retrieves the latest device position.
    
    Limitation — Device positions are deleted after one year.
    
    Parameters:
    
    getDevicePositionRequest -
    
    Returns:
    
    Result of the GetDevicePosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getDevicePositionHistory
```
GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
```
    Retrieves the device position history from a tracker resource within a specified range of time.
    
    Limitation — Device positions are deleted after one year.
    
    Parameters:
    
    getDevicePositionHistoryRequest -
    
    Returns:
    
    Result of the GetDevicePositionHistory operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getGeofence
```
GetGeofenceResult getGeofence(GetGeofenceRequest getGeofenceRequest)
```
    Retrieves the geofence details from a geofence collection.
    
    Parameters:
    
    getGeofenceRequest -
    
    Returns:
    
    Result of the GetGeofence operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getMapGlyphs
```
GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)
```
    Retrieves glyphs used to display labels on a map.
    
    Parameters:
    
    getMapGlyphsRequest -
    
    Returns:
    
    Result of the GetMapGlyphs operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getMapSprites
```
GetMapSpritesResult getMapSprites(GetMapSpritesRequest getMapSpritesRequest)
```
    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.
    
    Parameters:
    
    getMapSpritesRequest -
    
    Returns:
    
    Result of the GetMapSprites operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getMapStyleDescriptor
```
GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)
```
    Retrieves the map style descriptor from a map resource.
    
    The style descriptor contains speciﬁcations 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.
    
    Parameters:
    
    getMapStyleDescriptorRequest -
    
    Returns:
    
    Result of the GetMapStyleDescriptor operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getMapTile
```
GetMapTileResult getMapTile(GetMapTileRequest getMapTileRequest)
```
    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).
    
    Parameters:
    
    getMapTileRequest -
    
    Returns:
    
    Result of the GetMapTile operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listGeofenceCollections
```
ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
```
    Lists geofence collections in your AWS account.
    
    Parameters:
    
    listGeofenceCollectionsRequest -
    
    Returns:
    
    Result of the ListGeofenceCollections operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listGeofences
```
ListGeofencesResult listGeofences(ListGeofencesRequest listGeofencesRequest)
```
    Lists geofences stored in a given geofence collection.
    
    Parameters:
    
    listGeofencesRequest -
    
    Returns:
    
    Result of the ListGeofences operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listMaps
```
ListMapsResult listMaps(ListMapsRequest listMapsRequest)
```
    Lists map resources in your AWS account.
    
    Parameters:
    
    listMapsRequest -
    
    Returns:
    
    Result of the ListMaps operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listPlaceIndexes
```
ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
```
    Lists Place index resources in your AWS account.
    
    Parameters:
    
    listPlaceIndexesRequest -
    
    Returns:
    
    Result of the ListPlaceIndexes operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listTrackerConsumers
```
ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
```
    Lists geofence collections currently associated to the given tracker resource.
    
    Parameters:
    
    listTrackerConsumersRequest -
    
    Returns:
    
    Result of the ListTrackerConsumers operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listTrackers
```
ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest)
```
    Lists tracker resources in your AWS account.
    
    Parameters:
    
    listTrackersRequest -
    
    Returns:
    
    Result of the ListTrackers operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - putGeofence
```
PutGeofenceResult putGeofence(PutGeofenceRequest putGeofenceRequest)
```
    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.
    
    Parameters:
    
    putGeofenceRequest -
    
    Returns:
    
    Result of the PutGeofence operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    ConflictException - The request was unsuccessful due to a conflict.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - searchPlaceIndexForPosition
```
SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)
```
    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.
    
    Parameters:
    
    searchPlaceIndexForPositionRequest -
    
    Returns:
    
    Result of the SearchPlaceIndexForPosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - searchPlaceIndexForText
```
SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)
```
    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.
    
    Parameters:
    
    searchPlaceIndexForTextRequest -
    
    Returns:
    
    Result of the SearchPlaceIndexForText operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
    
    ValidationException - The input failed to meet the constraints specified by the AWS service.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonLocation

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

associateTrackerConsumer

batchDeleteGeofence

batchEvaluateGeofences

batchGetDevicePosition

batchPutGeofence

batchUpdateDevicePosition

createGeofenceCollection

createMap

createPlaceIndex

createTracker

deleteGeofenceCollection

deleteMap

deletePlaceIndex

deleteTracker

describeGeofenceCollection

describeMap

describePlaceIndex

describeTracker

disassociateTrackerConsumer

getDevicePosition

getDevicePositionHistory

getGeofence

getMapGlyphs

getMapSprites

getMapStyleDescriptor

getMapTile

listGeofenceCollections

listGeofences

listMaps

listPlaceIndexes

listTrackerConsumers

listTrackers

putGeofence

searchPlaceIndexForPosition

searchPlaceIndexForText

shutdown

getCachedResponseMetadata