com.amazonaws.services.geo

Interface AmazonLocation

All Known Implementing Classes:

AmazonLocationClient

public interface AmazonLocation

Interface for accessing AWS Location service

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

Method Summary

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	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://geo.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://geo.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "geo.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://geo.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "geo.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://geo.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

associateTrackerConsumer

AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

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:

associateTrackerConsumerResult The response from the AssociateTrackerConsumer service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

ConflictException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

batchDeleteGeofence

BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Deletes a batch of geofences from a geofence collection.

This action deletes the resource permanently. You can't undo this action.

Parameters:

batchDeleteGeofenceRequest -

Returns:

batchDeleteGeofenceResult The response from the BatchDeleteGeofence service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

batchEvaluateGeofences

BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Used in geofence monitoring. Evaluates device positions against the position of geofences in a given geofence collection.

Parameters:

batchEvaluateGeofencesRequest -

Returns:

batchEvaluateGeofencesResult The response from the BatchEvaluateGeofences service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

batchGetDevicePosition

BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

A batch request to retrieve device positions.

The response will return the device positions from the last 24 hours.

Parameters:

batchGetDevicePositionRequest -

Returns:

batchGetDevicePositionResult The response from the BatchGetDevicePosition service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

batchPutGeofence

BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

A batch request for storing geofences into a given geofence collection.

Parameters:

batchPutGeofenceRequest -

Returns:

batchPutGeofenceResult The response from the BatchPutGeofence service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

batchUpdateDevicePosition

BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)
                                                   throws AmazonClientException,
                                                          AmazonServiceException

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:

batchUpdateDevicePositionResult The response from the BatchUpdateDevicePosition service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

createGeofenceCollection

CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

Creates a geofence collection, which manages and stores geofences.

Parameters:

createGeofenceCollectionRequest -

Returns:

createGeofenceCollectionResult The response from the CreateGeofenceCollection service method, as returned by AWS Location service.

Throws:

InternalServerException

ConflictException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

createMap

CreateMapResult createMap(CreateMapRequest createMapRequest)
                   throws AmazonClientException,
                          AmazonServiceException

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:

createMapResult The response from the CreateMap service method, as returned by AWS Location service.

Throws:

InternalServerException

ConflictException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

createPlaceIndex

CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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:

createPlaceIndexResult The response from the CreatePlaceIndex service method, as returned by AWS Location service.

Throws:

InternalServerException

ConflictException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

createTracker

CreateTrackerResult createTracker(CreateTrackerRequest createTrackerRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

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

Parameters:

createTrackerRequest -

Returns:

createTrackerResult The response from the CreateTracker service method, as returned by AWS Location service.

Throws:

InternalServerException

ConflictException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

deleteGeofenceCollection

DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

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:

deleteGeofenceCollectionResult The response from the DeleteGeofenceCollection service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

deleteMap

DeleteMapResult deleteMap(DeleteMapRequest deleteMapRequest)
                   throws AmazonClientException,
                          AmazonServiceException

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:

deleteMapResult The response from the DeleteMap service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

deletePlaceIndex

DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Deletes a Place index resource from your AWS account.

This action deletes the resource permanently. You cannot undo this action.

Parameters:

deletePlaceIndexRequest -

Returns:

deletePlaceIndexResult The response from the DeletePlaceIndex service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

deleteTracker

DeleteTrackerResult deleteTracker(DeleteTrackerRequest deleteTrackerRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

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:

deleteTrackerResult The response from the DeleteTracker service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

describeGeofenceCollection

DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)
                                                     throws AmazonClientException,
                                                            AmazonServiceException

Retrieves the geofence collection details.

Parameters:

describeGeofenceCollectionRequest -

Returns:

describeGeofenceCollectionResult The response from the DescribeGeofenceCollection service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

describeMap

DescribeMapResult describeMap(DescribeMapRequest describeMapRequest)
                       throws AmazonClientException,
                              AmazonServiceException

Retrieves the map resource details.

Parameters:

describeMapRequest -

Returns:

describeMapResult The response from the DescribeMap service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

describePlaceIndex

DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Retrieves the Place index resource details.

Parameters:

describePlaceIndexRequest -

Returns:

describePlaceIndexResult The response from the DescribePlaceIndex service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

describeTracker

DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrackerRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Retrieves the tracker resource details.

Parameters:

describeTrackerRequest -

Returns:

describeTrackerResult The response from the DescribeTracker service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

disassociateTrackerConsumer

DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

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:

disassociateTrackerConsumerResult The response from the DisassociateTrackerConsumer service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

getDevicePosition

GetDevicePositionResult getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Retrieves the latest device position.

Limitation — Device positions are deleted after one year.

Parameters:

getDevicePositionRequest -

Returns:

getDevicePositionResult The response from the GetDevicePosition service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

getDevicePositionHistory

GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

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:

getDevicePositionHistoryResult The response from the GetDevicePositionHistory service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

getGeofence

GetGeofenceResult getGeofence(GetGeofenceRequest getGeofenceRequest)
                       throws AmazonClientException,
                              AmazonServiceException

Retrieves the geofence details from a geofence collection.

Parameters:

getGeofenceRequest -

Returns:

getGeofenceResult The response from the GetGeofence service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

getMapGlyphs

GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Retrieves glyphs used to display labels on a map.

Parameters:

getMapGlyphsRequest -

Returns:

getMapGlyphsResult The response from the GetMapGlyphs service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

getMapSprites

GetMapSpritesResult getMapSprites(GetMapSpritesRequest getMapSpritesRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

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:

getMapSpritesResult The response from the GetMapSprites service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

getMapStyleDescriptor

GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Retrieves the map style descriptor from a map resource.

The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.

Parameters:

getMapStyleDescriptorRequest -

Returns:

getMapStyleDescriptorResult The response from the GetMapStyleDescriptor service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

getMapTile

GetMapTileResult getMapTile(GetMapTileRequest getMapTileRequest)
                     throws AmazonClientException,
                            AmazonServiceException

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:

getMapTileResult The response from the GetMapTile service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

listGeofenceCollections

ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

Lists geofence collections in your AWS account.

Parameters:

listGeofenceCollectionsRequest -

Returns:

listGeofenceCollectionsResult The response from the ListGeofenceCollections service method, as returned by AWS Location service.

Throws:

InternalServerException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

listGeofences

ListGeofencesResult listGeofences(ListGeofencesRequest listGeofencesRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Lists geofences stored in a given geofence collection.

Parameters:

listGeofencesRequest -

Returns:

listGeofencesResult The response from the ListGeofences service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

listMaps

ListMapsResult listMaps(ListMapsRequest listMapsRequest)
                 throws AmazonClientException,
                        AmazonServiceException

Lists map resources in your AWS account.

Parameters:

listMapsRequest -

Returns:

listMapsResult The response from the ListMaps service method, as returned by AWS Location service.

Throws:

InternalServerException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

listPlaceIndexes

ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Lists Place index resources in your AWS account.

Parameters:

listPlaceIndexesRequest -

Returns:

listPlaceIndexesResult The response from the ListPlaceIndexes service method, as returned by AWS Location service.

Throws:

InternalServerException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

listTrackerConsumers

ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Lists geofence collections currently associated to the given tracker resource.

Parameters:

listTrackerConsumersRequest -

Returns:

listTrackerConsumersResult The response from the ListTrackerConsumers service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

listTrackers

ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Lists tracker resources in your AWS account.

Parameters:

listTrackersRequest -

Returns:

listTrackersResult The response from the ListTrackers service method, as returned by AWS Location service.

Throws:

InternalServerException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

putGeofence

PutGeofenceResult putGeofence(PutGeofenceRequest putGeofenceRequest)
                       throws AmazonClientException,
                              AmazonServiceException

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:

putGeofenceResult The response from the PutGeofence service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

ConflictException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

searchPlaceIndexForPosition

SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

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:

searchPlaceIndexForPositionResult The response from the SearchPlaceIndexForPosition service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

searchPlaceIndexForText

SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

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:

searchPlaceIndexForTextResult The response from the SearchPlaceIndexForText service method, as returned by AWS Location service.

Throws:

InternalServerException

ResourceNotFoundException

AccessDeniedException

ValidationException

ThrottlingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS Location service indicating either a problem with the data in the request, or a server side issue.

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.