com.amazonaws.services.geo

Class AmazonLocationClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.geo.AmazonLocationClient

All Implemented Interfaces:

AmazonLocation

public class AmazonLocationClient
extends AmazonWebServiceClient
implements AmazonLocation

Client for accessing AWS 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

Constructor Summary

Constructors

Constructor and Description
AmazonLocationClient() Deprecated.
AmazonLocationClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials.
AmazonLocationClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials and client configuration options.
AmazonLocationClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials provider.
AmazonLocationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials provider and client configuration options.
AmazonLocationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonLocationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AmazonLocationClient(ClientConfiguration clientConfiguration) Deprecated.

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) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.geo.AmazonLocation

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonLocationClient

@Deprecated
public AmazonLocationClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonLocation. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonLocationClient

@Deprecated
public AmazonLocationClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonLocation. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonLocation (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonLocationClient

public AmazonLocationClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLocationClient client = new AmazonLocationClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonLocationClient

public AmazonLocationClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLocationClient client = new AmazonLocationClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonLocation (ex: proxy settings, retry counts, etc.).

AmazonLocationClient

public AmazonLocationClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLocationClient client = new AmazonLocationClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonLocationClient

public AmazonLocationClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLocationClient client = new AmazonLocationClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonLocation (ex: proxy settings, retry counts, etc.).

AmazonLocationClient

@Deprecated
public AmazonLocationClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration,
                                        com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonLocation (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonLocationClient

public AmazonLocationClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonLocation using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLocationClient client = new AmazonLocationClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonLocation (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

associateTrackerConsumer

public AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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:

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

public BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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:

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

public BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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:

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

public BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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:

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

public BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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

Specified by:

batchPutGeofence in interface AmazonLocation

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

public BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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:

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

public CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Creates a geofence collection, which manages and stores geofences.

Specified by:

createGeofenceCollection in interface AmazonLocation

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

public CreateMapResult createMap(CreateMapRequest createMapRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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:

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

public CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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:

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

public CreateTrackerResult createTracker(CreateTrackerRequest createTrackerRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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:

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

public DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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:

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

public DeleteMapResult deleteMap(DeleteMapRequest deleteMapRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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:

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

public DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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:

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

public DeleteTrackerResult deleteTracker(DeleteTrackerRequest deleteTrackerRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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:

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

public DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Retrieves the geofence collection details.

Specified by:

describeGeofenceCollection in interface AmazonLocation

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

public DescribeMapResult describeMap(DescribeMapRequest describeMapRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Retrieves the map resource details.

Specified by:

describeMap in interface AmazonLocation

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

public DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Retrieves the Place index resource details.

Specified by:

describePlaceIndex in interface AmazonLocation

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

public DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrackerRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Retrieves the tracker resource details.

Specified by:

describeTracker in interface AmazonLocation

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

public DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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:

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

public GetDevicePositionResult getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Retrieves the latest device position.

Limitation — Device positions are deleted after one year.

Specified by:

getDevicePosition in interface AmazonLocation

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

public GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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:

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

public GetGeofenceResult getGeofence(GetGeofenceRequest getGeofenceRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Retrieves the geofence details from a geofence collection.

Specified by:

getGeofence in interface AmazonLocation

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

public GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Retrieves glyphs used to display labels on a map.

Specified by:

getMapGlyphs in interface AmazonLocation

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

public GetMapSpritesResult getMapSprites(GetMapSpritesRequest getMapSpritesRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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:

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

public GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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.

Specified by:

getMapStyleDescriptor in interface AmazonLocation

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

public GetMapTileResult getMapTile(GetMapTileRequest getMapTileRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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:

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

public ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Lists geofence collections in your AWS account.

Specified by:

listGeofenceCollections in interface AmazonLocation

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

public ListGeofencesResult listGeofences(ListGeofencesRequest listGeofencesRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Lists geofences stored in a given geofence collection.

Specified by:

listGeofences in interface AmazonLocation

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

public ListMapsResult listMaps(ListMapsRequest listMapsRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Lists map resources in your AWS account.

Specified by:

listMaps in interface AmazonLocation

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

public ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Lists Place index resources in your AWS account.

Specified by:

listPlaceIndexes in interface AmazonLocation

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

public ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Lists geofence collections currently associated to the given tracker resource.

Specified by:

listTrackerConsumers in interface AmazonLocation

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

public ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Lists tracker resources in your AWS account.

Specified by:

listTrackers in interface AmazonLocation

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

public PutGeofenceResult putGeofence(PutGeofenceRequest putGeofenceRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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:

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

public SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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:

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

public SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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:

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.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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.