AmazonLocationClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.location.AmazonLocationClient

All Implemented Interfaces:

AmazonLocation

Direct Known Subclasses:

AmazonLocationAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonLocationClient
extends AmazonWebServiceClient
implements AmazonLocation
```
Client for accessing Amazon Location Service. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.location.AmazonLocation
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateTrackerConsumerResult`	`associateTrackerConsumer(AssociateTrackerConsumerRequest request)` Creates an association between a geofence collection and a tracker resource.
`BatchDeleteGeofenceResult`	`batchDeleteGeofence(BatchDeleteGeofenceRequest request)` Deletes a batch of geofences from a geofence collection.
`BatchEvaluateGeofencesResult`	`batchEvaluateGeofences(BatchEvaluateGeofencesRequest request)` Used in geofence monitoring.
`BatchGetDevicePositionResult`	`batchGetDevicePosition(BatchGetDevicePositionRequest request)` A batch request to retrieve device positions.
`BatchPutGeofenceResult`	`batchPutGeofence(BatchPutGeofenceRequest request)` A batch request for storing geofences into a given geofence collection.
`BatchUpdateDevicePositionResult`	`batchUpdateDevicePosition(BatchUpdateDevicePositionRequest request)` Uploads a position update for one or more devices to a tracker resource.
`static AmazonLocationClientBuilder`	`builder()`
`CreateGeofenceCollectionResult`	`createGeofenceCollection(CreateGeofenceCollectionRequest request)` Creates a geofence collection, which manages and stores geofences.
`CreateMapResult`	`createMap(CreateMapRequest request)` Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
`CreatePlaceIndexResult`	`createPlaceIndex(CreatePlaceIndexRequest request)` 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 request)` Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
`DeleteGeofenceCollectionResult`	`deleteGeofenceCollection(DeleteGeofenceCollectionRequest request)` Deletes a geofence collection from your AWS account.
`DeleteMapResult`	`deleteMap(DeleteMapRequest request)` Deletes a map resource from your AWS account.
`DeletePlaceIndexResult`	`deletePlaceIndex(DeletePlaceIndexRequest request)` Deletes a Place index resource from your AWS account.
`DeleteTrackerResult`	`deleteTracker(DeleteTrackerRequest request)` Deletes a tracker resource from your AWS account.
`DescribeGeofenceCollectionResult`	`describeGeofenceCollection(DescribeGeofenceCollectionRequest request)` Retrieves the geofence collection details.
`DescribeMapResult`	`describeMap(DescribeMapRequest request)` Retrieves the map resource details.
`DescribePlaceIndexResult`	`describePlaceIndex(DescribePlaceIndexRequest request)` Retrieves the Place index resource details.
`DescribeTrackerResult`	`describeTracker(DescribeTrackerRequest request)` Retrieves the tracker resource details.
`DisassociateTrackerConsumerResult`	`disassociateTrackerConsumer(DisassociateTrackerConsumerRequest request)` 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 request)` Retrieves the latest device position.
`GetDevicePositionHistoryResult`	`getDevicePositionHistory(GetDevicePositionHistoryRequest request)` Retrieves the device position history from a tracker resource within a specified range of time.
`GetGeofenceResult`	`getGeofence(GetGeofenceRequest request)` Retrieves the geofence details from a geofence collection.
`GetMapGlyphsResult`	`getMapGlyphs(GetMapGlyphsRequest request)` Retrieves glyphs used to display labels on a map.
`GetMapSpritesResult`	`getMapSprites(GetMapSpritesRequest request)` Retrieves the sprite sheet corresponding to a map resource.
`GetMapStyleDescriptorResult`	`getMapStyleDescriptor(GetMapStyleDescriptorRequest request)` Retrieves the map style descriptor from a map resource.
`GetMapTileResult`	`getMapTile(GetMapTileRequest request)` Retrieves a vector data tile from the map resource.
`ListGeofenceCollectionsResult`	`listGeofenceCollections(ListGeofenceCollectionsRequest request)` Lists geofence collections in your AWS account.
`ListGeofencesResult`	`listGeofences(ListGeofencesRequest request)` Lists geofences stored in a given geofence collection.
`ListMapsResult`	`listMaps(ListMapsRequest request)` Lists map resources in your AWS account.
`ListPlaceIndexesResult`	`listPlaceIndexes(ListPlaceIndexesRequest request)` Lists Place index resources in your AWS account.
`ListTrackerConsumersResult`	`listTrackerConsumers(ListTrackerConsumersRequest request)` Lists geofence collections currently associated to the given tracker resource.
`ListTrackersResult`	`listTrackers(ListTrackersRequest request)` Lists tracker resources in your AWS account.
`PutGeofenceResult`	`putGeofence(PutGeofenceRequest request)` 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 request)` Reverse geocodes a given coordinate and returns a legible address.
`SearchPlaceIndexForTextResult`	`searchPlaceIndexForText(SearchPlaceIndexForTextRequest request)` 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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonLocationClientBuilder builder()
```
  - associateTrackerConsumer
```
public AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest request)
```
    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.
    
    Specified by:
    
    associateTrackerConsumer in interface AmazonLocation
    
    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
```
public BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest request)
```
    Deletes a batch of geofences from a geofence collection.
    
    This action deletes the resource permanently. You can't undo this action.
    
    Specified by:
    
    batchDeleteGeofence in interface AmazonLocation
    
    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
```
public BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest request)
```
    Used in geofence monitoring. Evaluates device positions against the position of geofences in a given geofence collection.
    
    Specified by:
    
    batchEvaluateGeofences in interface AmazonLocation
    
    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
```
public BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest request)
```
    A batch request to retrieve device positions.
    
    The response will return the device positions from the last 24 hours.
    
    Specified by:
    
    batchGetDevicePosition in interface AmazonLocation
    
    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
```
public BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest request)
```
    A batch request for storing geofences into a given geofence collection.
    
    Specified by:
    
    batchPutGeofence in interface AmazonLocation
    
    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
```
public BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest request)
```
    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.
    
    Specified by:
    
    batchUpdateDevicePosition in interface AmazonLocation
    
    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
```
public CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest request)
```
    Creates a geofence collection, which manages and stores geofences.
    
    Specified by:
    
    createGeofenceCollection in interface AmazonLocation
    
    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
```
public CreateMapResult createMap(CreateMapRequest request)
```
    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.
    
    Specified by:
    
    createMap in interface AmazonLocation
    
    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
```
public CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest request)
```
    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.
    
    Specified by:
    
    createPlaceIndex in interface AmazonLocation
    
    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
```
public CreateTrackerResult createTracker(CreateTrackerRequest request)
```
    Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
    
    Specified by:
    
    createTracker in interface AmazonLocation
    
    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
```
public DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest request)
```
    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.
    
    Specified by:
    
    deleteGeofenceCollection in interface AmazonLocation
    
    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
```
public DeleteMapResult deleteMap(DeleteMapRequest request)
```
    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.
    
    Specified by:
    
    deleteMap in interface AmazonLocation
    
    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
```
public DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest request)
```
    Deletes a Place index resource from your AWS account.
    
    This action deletes the resource permanently. You cannot undo this action.
    
    Specified by:
    
    deletePlaceIndex in interface AmazonLocation
    
    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
```
public DeleteTrackerResult deleteTracker(DeleteTrackerRequest request)
```
    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.
    
    Specified by:
    
    deleteTracker in interface AmazonLocation
    
    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
```
public DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest request)
```
    Retrieves the geofence collection details.
    
    Specified by:
    
    describeGeofenceCollection in interface AmazonLocation
    
    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
```
public DescribeMapResult describeMap(DescribeMapRequest request)
```
    Retrieves the map resource details.
    
    Specified by:
    
    describeMap in interface AmazonLocation
    
    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
```
public DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest request)
```
    Retrieves the Place index resource details.
    
    Specified by:
    
    describePlaceIndex in interface AmazonLocation
    
    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
```
public DescribeTrackerResult describeTracker(DescribeTrackerRequest request)
```
    Retrieves the tracker resource details.
    
    Specified by:
    
    describeTracker in interface AmazonLocation
    
    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
```
public DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest request)
```
    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.
    
    Specified by:
    
    disassociateTrackerConsumer in interface AmazonLocation
    
    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
```
public GetDevicePositionResult getDevicePosition(GetDevicePositionRequest request)
```
    Retrieves the latest device position.
    
    Limitation — Device positions are deleted after one year.
    
    Specified by:
    
    getDevicePosition in interface AmazonLocation
    
    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
```
public GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest request)
```
    Retrieves the device position history from a tracker resource within a specified range of time.
    
    Limitation — Device positions are deleted after one year.
    
    Specified by:
    
    getDevicePositionHistory in interface AmazonLocation
    
    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
```
public GetGeofenceResult getGeofence(GetGeofenceRequest request)
```
    Retrieves the geofence details from a geofence collection.
    
    Specified by:
    
    getGeofence in interface AmazonLocation
    
    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
```
public GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest request)
```
    Retrieves glyphs used to display labels on a map.
    
    Specified by:
    
    getMapGlyphs in interface AmazonLocation
    
    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
```
public GetMapSpritesResult getMapSprites(GetMapSpritesRequest request)
```
    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.
    
    Specified by:
    
    getMapSprites in interface AmazonLocation
    
    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
```
public GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest request)
```
    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.
    
    Specified by:
    
    getMapStyleDescriptor in interface AmazonLocation
    
    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
```
public GetMapTileResult getMapTile(GetMapTileRequest request)
```
    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).
    
    Specified by:
    
    getMapTile in interface AmazonLocation
    
    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
```
public ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest request)
```
    Lists geofence collections in your AWS account.
    
    Specified by:
    
    listGeofenceCollections in interface AmazonLocation
    
    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
```
public ListGeofencesResult listGeofences(ListGeofencesRequest request)
```
    Lists geofences stored in a given geofence collection.
    
    Specified by:
    
    listGeofences in interface AmazonLocation
    
    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
```
public ListMapsResult listMaps(ListMapsRequest request)
```
    Lists map resources in your AWS account.
    
    Specified by:
    
    listMaps in interface AmazonLocation
    
    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
```
public ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest request)
```
    Lists Place index resources in your AWS account.
    
    Specified by:
    
    listPlaceIndexes in interface AmazonLocation
    
    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
```
public ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest request)
```
    Lists geofence collections currently associated to the given tracker resource.
    
    Specified by:
    
    listTrackerConsumers in interface AmazonLocation
    
    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
```
public ListTrackersResult listTrackers(ListTrackersRequest request)
```
    Lists tracker resources in your AWS account.
    
    Specified by:
    
    listTrackers in interface AmazonLocation
    
    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
```
public PutGeofenceResult putGeofence(PutGeofenceRequest request)
```
    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.
    
    Specified by:
    
    putGeofence in interface AmazonLocation
    
    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
```
public SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest request)
```
    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.
    
    Specified by:
    
    searchPlaceIndexForPosition in interface AmazonLocation
    
    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
```
public SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest request)
```
    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.
    
    Specified by:
    
    searchPlaceIndexForText in interface AmazonLocation
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonLocation
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonLocation
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonLocationClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.location.AmazonLocation

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

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

getCachedResponseMetadata

shutdown