com.amazonaws.services.location

Interface AmazonLocation

All Known Subinterfaces:

AmazonLocationAsync

All Known Implementing Classes:

AbstractAmazonLocation, AbstractAmazonLocationAsync, AmazonLocationAsyncClient, AmazonLocationClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLocation

Interface for accessing Amazon Location Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonLocation instead.

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
AssociateTrackerConsumerResult	associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest) Creates an association between a geofence collection and a tracker resource.
BatchDeleteDevicePositionHistoryResult	batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest) Deletes the position history of one or more devices from a tracker resource.
BatchDeleteGeofenceResult	batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest) Deletes a batch of geofences from a geofence collection.
BatchEvaluateGeofencesResult	batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest) Evaluates device positions against the geofence geometries from a given geofence collection.
BatchGetDevicePositionResult	batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest) A batch request to retrieve all device positions.
BatchPutGeofenceResult	batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest) A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
BatchUpdateDevicePositionResult	batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest) Uploads position update data for one or more devices to a tracker resource.
CalculateRouteResult	calculateRoute(CalculateRouteRequest calculateRouteRequest) Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition.
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 functions with geospatial data sourced from your chosen data provider.
CreateRouteCalculatorResult	createRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest) Creates a route calculator resource in your AWS account.
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.
DeleteRouteCalculatorResult	deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest) Deletes a route calculator 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.
DescribeRouteCalculatorResult	describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest) Retrieves the route calculator resource details.
DescribeTrackerResult	describeTracker(DescribeTrackerRequest describeTrackerRequest) Retrieves the tracker resource details.
DisassociateTrackerConsumerResult	disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest) Removes the association between 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 a device's most recent position according to its sample time.
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.
ListDevicePositionsResult	listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest) Lists the latest device positions for requested devices.
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.
ListRouteCalculatorsResult	listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest) Lists route calculator resources in your AWS account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns the tags for the specified Amazon Location Service resource.
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 geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
SearchPlaceIndexForPositionResult	searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest) Reverse geocodes a given coordinate and returns a legible address.
SearchPlaceIndexForTextResult	searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest) Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified Amazon Location Service resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateTrackerConsumer

AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)

Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

Parameters:

associateTrackerConsumerRequest -

Returns:

Result of the AssociateTrackerConsumer operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

ConflictException - The request was unsuccessful due to a conflict.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

batchDeleteDevicePositionHistory

BatchDeleteDevicePositionHistoryResult batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest)

Deletes the position history of one or more devices from a tracker resource.

Parameters:

batchDeleteDevicePositionHistoryRequest -

Returns:

Result of the BatchDeleteDevicePositionHistory operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

batchDeleteGeofence

BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)

Deletes a batch of geofences from a geofence collection.

This operation deletes the resource permanently.

Parameters:

batchDeleteGeofenceRequest -

Returns:

Result of the BatchDeleteGeofence operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

batchEvaluateGeofences

BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)

Evaluates device positions against the geofence geometries from a given geofence collection. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge.

The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update

Parameters:

batchEvaluateGeofencesRequest -

Returns:

Result of the BatchEvaluateGeofences operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

batchGetDevicePosition

BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)

A batch request to retrieve all device positions.

Parameters:

batchGetDevicePositionRequest -

Returns:

Result of the BatchGetDevicePosition operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

batchPutGeofence

BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)

A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

Parameters:

batchPutGeofenceRequest -

Returns:

Result of the BatchPutGeofence operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

batchUpdateDevicePosition

BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)

Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history.

Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval and retained for 30 days before it's deleted.

Parameters:

batchUpdateDevicePositionRequest -

Returns:

Result of the BatchUpdateDevicePosition operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

calculateRoute

CalculateRouteResult calculateRoute(CalculateRouteRequest calculateRouteRequest)

Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition. Requires that you first create aroute calculator resource

By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.

Additional options include:

• Specifying a departure time using either DepartureTime or DepartureNow. This calculates a route based on predictive traffic data at the given time.

  You can't specify both DepartureTime and DepartureNow in a single request. Specifying both parameters returns an error message.

• Specifying a travel mode using TravelMode. This lets you specify additional route preference such as CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.

Parameters:

calculateRouteRequest -

Returns:

Result of the CalculateRoute operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

createGeofenceCollection

CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)

Creates a geofence collection, which manages and stores geofences.

Parameters:

createGeofenceCollectionRequest -

Returns:

Result of the CreateGeofenceCollection operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ConflictException - The request was unsuccessful due to a conflict.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

createMap

CreateMapResult createMap(CreateMapRequest createMapRequest)

Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

Parameters:

createMapRequest -

Returns:

Result of the CreateMap operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ConflictException - The request was unsuccessful due to a conflict.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

createPlaceIndex

CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)

Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider.

Parameters:

createPlaceIndexRequest -

Returns:

Result of the CreatePlaceIndex operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ConflictException - The request was unsuccessful due to a conflict.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

createRouteCalculator

CreateRouteCalculatorResult createRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest)

Creates a route calculator resource in your AWS account.

You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

Parameters:

createRouteCalculatorRequest -

Returns:

Result of the CreateRouteCalculator operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ConflictException - The request was unsuccessful due to a conflict.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

createTracker

CreateTrackerResult createTracker(CreateTrackerRequest createTrackerRequest)

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

Parameters:

createTrackerRequest -

Returns:

Result of the CreateTracker operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ConflictException - The request was unsuccessful due to a conflict.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteGeofenceCollection

DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)

Deletes a geofence collection from your AWS account.

This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

Parameters:

deleteGeofenceCollectionRequest -

Returns:

Result of the DeleteGeofenceCollection operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteMap

DeleteMapResult deleteMap(DeleteMapRequest deleteMapRequest)

Deletes a map resource from your AWS account.

This operation deletes the resource permanently. If the map is being used in an application, the map may not render.

Parameters:

deleteMapRequest -

Returns:

Result of the DeleteMap operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deletePlaceIndex

DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)

Deletes a place index resource from your AWS account.

This operation deletes the resource permanently.

Parameters:

deletePlaceIndexRequest -

Returns:

Result of the DeletePlaceIndex operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteRouteCalculator

DeleteRouteCalculatorResult deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest)

Deletes a route calculator resource from your AWS account.

This operation deletes the resource permanently.

Parameters:

deleteRouteCalculatorRequest -

Returns:

Result of the DeleteRouteCalculator operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteTracker

DeleteTrackerResult deleteTracker(DeleteTrackerRequest deleteTrackerRequest)

Deletes a tracker resource from your AWS account.

This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.

Parameters:

deleteTrackerRequest -

Returns:

Result of the DeleteTracker operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeGeofenceCollection

DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)

Retrieves the geofence collection details.

Parameters:

describeGeofenceCollectionRequest -

Returns:

Result of the DescribeGeofenceCollection operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeMap

DescribeMapResult describeMap(DescribeMapRequest describeMapRequest)

Retrieves the map resource details.

Parameters:

describeMapRequest -

Returns:

Result of the DescribeMap operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describePlaceIndex

DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)

Retrieves the place index resource details.

Parameters:

describePlaceIndexRequest -

Returns:

Result of the DescribePlaceIndex operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeRouteCalculator

DescribeRouteCalculatorResult describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest)

Retrieves the route calculator resource details.

Parameters:

describeRouteCalculatorRequest -

Returns:

Result of the DescribeRouteCalculator operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeTracker

DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrackerRequest)

Retrieves the tracker resource details.

Parameters:

describeTrackerRequest -

Returns:

Result of the DescribeTracker operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

disassociateTrackerConsumer

DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)

Removes the association between a tracker resource and a geofence collection.

Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.

Parameters:

disassociateTrackerConsumerRequest -

Returns:

Result of the DisassociateTrackerConsumer operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getDevicePosition

GetDevicePositionResult getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)

Retrieves a device's most recent position according to its sample time.

Device positions are deleted after 30 days.

Parameters:

getDevicePositionRequest -

Returns:

Result of the GetDevicePosition operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getDevicePositionHistory

GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)

Retrieves the device position history from a tracker resource within a specified range of time.

Device positions are deleted after 30 days.

Parameters:

getDevicePositionHistoryRequest -

Returns:

Result of the GetDevicePositionHistory operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getGeofence

GetGeofenceResult getGeofence(GetGeofenceRequest getGeofenceRequest)

Retrieves the geofence details from a geofence collection.

Parameters:

getGeofenceRequest -

Returns:

Result of the GetGeofence operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getMapGlyphs

GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)

Retrieves glyphs used to display labels on a map.

Parameters:

getMapGlyphsRequest -

Returns:

Result of the GetMapGlyphs operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getMapSprites

GetMapSpritesResult getMapSprites(GetMapSpritesRequest getMapSpritesRequest)

Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.

Parameters:

getMapSpritesRequest -

Returns:

Result of the GetMapSprites operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getMapStyleDescriptor

GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)

Retrieves the map style descriptor from a map resource.

The style descriptor contains 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:

Result of the GetMapStyleDescriptor operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getMapTile

GetMapTileResult getMapTile(GetMapTileRequest getMapTileRequest)

Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

Parameters:

getMapTileRequest -

Returns:

Result of the GetMapTile operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listDevicePositions

ListDevicePositionsResult listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)

Lists the latest device positions for requested devices.

Parameters:

listDevicePositionsRequest -

Returns:

Result of the ListDevicePositions operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listGeofenceCollections

ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)

Lists geofence collections in your AWS account.

Parameters:

listGeofenceCollectionsRequest -

Returns:

Result of the ListGeofenceCollections operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listGeofences

ListGeofencesResult listGeofences(ListGeofencesRequest listGeofencesRequest)

Lists geofences stored in a given geofence collection.

Parameters:

listGeofencesRequest -

Returns:

Result of the ListGeofences operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listMaps

ListMapsResult listMaps(ListMapsRequest listMapsRequest)

Lists map resources in your AWS account.

Parameters:

listMapsRequest -

Returns:

Result of the ListMaps operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listPlaceIndexes

ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)

Lists place index resources in your AWS account.

Parameters:

listPlaceIndexesRequest -

Returns:

Result of the ListPlaceIndexes operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listRouteCalculators

ListRouteCalculatorsResult listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest)

Lists route calculator resources in your AWS account.

Parameters:

listRouteCalculatorsRequest -

Returns:

Result of the ListRouteCalculators operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns the tags for the specified Amazon Location Service resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listTrackerConsumers

ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)

Lists geofence collections currently associated to the given tracker resource.

Parameters:

listTrackerConsumersRequest -

Returns:

Result of the ListTrackerConsumers operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listTrackers

ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest)

Lists tracker resources in your AWS account.

Parameters:

listTrackersRequest -

Returns:

Result of the ListTrackers operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

putGeofence

PutGeofenceResult putGeofence(PutGeofenceRequest putGeofenceRequest)

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

Parameters:

putGeofenceRequest -

Returns:

Result of the PutGeofence operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

ConflictException - The request was unsuccessful due to a conflict.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

searchPlaceIndexForPosition

SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

Parameters:

searchPlaceIndexForPositionRequest -

Returns:

Result of the SearchPlaceIndexForPosition operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

searchPlaceIndexForText

SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Includes the option to apply additional parameters to narrow your list of results.

You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.

Parameters:

searchPlaceIndexForTextRequest -

Returns:

Result of the SearchPlaceIndexForText operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.

  <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate as many as 50 tags with a resource.</p> 
 

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from the specified Amazon Location Service resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.

ResourceNotFoundException - The resource that you've entered was not found in your AWS account.

AccessDeniedException - The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

ValidationException - The input failed to meet the constraints specified by the AWS service.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.