@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonLocationClient extends AmazonWebServiceClient implements AmazonLocation
Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AssociateTrackerConsumerResult |
associateTrackerConsumer(AssociateTrackerConsumerRequest request)
Creates an association between a geofence collection and a tracker resource.
|
BatchDeleteDevicePositionHistoryResult |
batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest request)
Deletes the position history of one or more devices from a tracker resource.
|
BatchDeleteGeofenceResult |
batchDeleteGeofence(BatchDeleteGeofenceRequest request)
Deletes a batch of geofences from a geofence collection.
|
BatchEvaluateGeofencesResult |
batchEvaluateGeofences(BatchEvaluateGeofencesRequest request)
Evaluates device positions against the geofence geometries from a given geofence collection.
|
BatchGetDevicePositionResult |
batchGetDevicePosition(BatchGetDevicePositionRequest request)
Lists the latest device positions for requested devices.
|
BatchPutGeofenceResult |
batchPutGeofence(BatchPutGeofenceRequest request)
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 request)
Uploads position update data for one or more devices to a tracker resource.
|
static AmazonLocationClientBuilder |
builder() |
CalculateRouteResult |
calculateRoute(CalculateRouteRequest request)
Calculates a route
given the following required parameters:
DeparturePostiton and DestinationPosition. |
CreateGeofenceCollectionResult |
createGeofenceCollection(CreateGeofenceCollectionRequest request)
Creates a geofence collection, which manages and stores geofences.
|
CreateMapResult |
createMap(CreateMapRequest request)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global
location data providers.
|
CreatePlaceIndexResult |
createPlaceIndex(CreatePlaceIndexRequest request)
Creates a place index resource in your AWS account.
|
CreateRouteCalculatorResult |
createRouteCalculator(CreateRouteCalculatorRequest request)
Creates a route calculator resource in your AWS account.
|
CreateTrackerResult |
createTracker(CreateTrackerRequest request)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of
devices.
|
DeleteGeofenceCollectionResult |
deleteGeofenceCollection(DeleteGeofenceCollectionRequest request)
Deletes a geofence collection from your AWS account.
|
DeleteMapResult |
deleteMap(DeleteMapRequest request)
Deletes a map resource from your AWS account.
|
DeletePlaceIndexResult |
deletePlaceIndex(DeletePlaceIndexRequest request)
Deletes a place index resource from your AWS account.
|
DeleteRouteCalculatorResult |
deleteRouteCalculator(DeleteRouteCalculatorRequest request)
Deletes a route calculator resource from your AWS account.
|
DeleteTrackerResult |
deleteTracker(DeleteTrackerRequest request)
Deletes a tracker resource from your AWS account.
|
DescribeGeofenceCollectionResult |
describeGeofenceCollection(DescribeGeofenceCollectionRequest request)
Retrieves the geofence collection details.
|
DescribeMapResult |
describeMap(DescribeMapRequest request)
Retrieves the map resource details.
|
DescribePlaceIndexResult |
describePlaceIndex(DescribePlaceIndexRequest request)
Retrieves the place index resource details.
|
DescribeRouteCalculatorResult |
describeRouteCalculator(DescribeRouteCalculatorRequest request)
Retrieves the route calculator resource details.
|
DescribeTrackerResult |
describeTracker(DescribeTrackerRequest request)
Retrieves the tracker resource details.
|
DisassociateTrackerConsumerResult |
disassociateTrackerConsumer(DisassociateTrackerConsumerRequest request)
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 request)
Retrieves a device's most recent position according to its sample time.
|
GetDevicePositionHistoryResult |
getDevicePositionHistory(GetDevicePositionHistoryRequest request)
Retrieves the device position history from a tracker resource within a specified range of time.
|
GetGeofenceResult |
getGeofence(GetGeofenceRequest request)
Retrieves the geofence details from a geofence collection.
|
GetMapGlyphsResult |
getMapGlyphs(GetMapGlyphsRequest request)
Retrieves glyphs used to display labels on a map.
|
GetMapSpritesResult |
getMapSprites(GetMapSpritesRequest request)
Retrieves the sprite sheet corresponding to a map resource.
|
GetMapStyleDescriptorResult |
getMapStyleDescriptor(GetMapStyleDescriptorRequest request)
Retrieves the map style descriptor from a map resource.
|
GetMapTileResult |
getMapTile(GetMapTileRequest request)
Retrieves a vector data tile from the map resource.
|
ListDevicePositionsResult |
listDevicePositions(ListDevicePositionsRequest request)
A batch request to retrieve all device positions.
|
ListGeofenceCollectionsResult |
listGeofenceCollections(ListGeofenceCollectionsRequest request)
Lists geofence collections in your AWS account.
|
ListGeofencesResult |
listGeofences(ListGeofencesRequest request)
Lists geofences stored in a given geofence collection.
|
ListMapsResult |
listMaps(ListMapsRequest request)
Lists map resources in your AWS account.
|
ListPlaceIndexesResult |
listPlaceIndexes(ListPlaceIndexesRequest request)
Lists place index resources in your AWS account.
|
ListRouteCalculatorsResult |
listRouteCalculators(ListRouteCalculatorsRequest request)
Lists route calculator resources in your AWS account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags that are applied to the specified Amazon Location resource.
|
ListTrackerConsumersResult |
listTrackerConsumers(ListTrackerConsumersRequest request)
Lists geofence collections currently associated to the given tracker resource.
|
ListTrackersResult |
listTrackers(ListTrackersRequest request)
Lists tracker resources in your AWS account.
|
PutGeofenceResult |
putGeofence(PutGeofenceRequest request)
Stores a geofence 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 request)
Reverse geocodes a given coordinate and returns a legible address.
|
SearchPlaceIndexForTextResult |
searchPlaceIndexForText(SearchPlaceIndexForTextRequest request)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of
interest.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified Amazon Location resource.
|
UpdateGeofenceCollectionResult |
updateGeofenceCollection(UpdateGeofenceCollectionRequest request)
Updates the specified properties of a given geofence collection.
|
UpdateMapResult |
updateMap(UpdateMapRequest request)
Updates the specified properties of a given map resource.
|
UpdatePlaceIndexResult |
updatePlaceIndex(UpdatePlaceIndexRequest request)
Updates the specified properties of a given place index resource.
|
UpdateRouteCalculatorResult |
updateRouteCalculator(UpdateRouteCalculatorRequest request)
Updates the specified properties for a given route calculator resource.
|
UpdateTrackerResult |
updateTracker(UpdateTrackerRequest request)
Updates the specified properties of a given tracker resource.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetprotected static final ClientConfigurationFactory configFactory
public static AmazonLocationClientBuilder builder()
public AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest request)
Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
You can associate up to five geofence collections to each tracker resource.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
associateTrackerConsumer in interface AmazonLocationassociateTrackerConsumerRequest - 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 because of a conflict.AccessDeniedException - The request was denied because of insufficient access or permissions. Check with an administrator to
verify your permissions.ValidationException - The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException - The operation was denied because the request would exceed the maximum quota set for
Amazon Location Service.ThrottlingException - The request was denied because of request throttling.public BatchDeleteDevicePositionHistoryResult batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest request)
Deletes the position history of one or more devices from a tracker resource.
batchDeleteDevicePositionHistory in interface AmazonLocationbatchDeleteDevicePositionHistoryRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest request)
Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
batchDeleteGeofence in interface AmazonLocationbatchDeleteGeofenceRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest request)
Evaluates device positions against the geofence geometries from a given geofence collection.
This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:
ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
EXIT if Amazon Location determines that the tracked device has exited a geofenced area.
The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.
batchEvaluateGeofences in interface AmazonLocationbatchEvaluateGeofencesRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest request)
Lists the latest device positions for requested devices.
batchGetDevicePosition in interface AmazonLocationbatchGetDevicePositionRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest request)
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.
batchPutGeofence in interface AmazonLocationbatchPutGeofenceRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest request)
Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.
Position updates are handled based on the PositionFiltering property of the tracker. When
PositionFiltering is set to TimeBased, updates are evaluated against linked geofence
collections, and location data is stored at a maximum of one position per 30 second interval. If your update
frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device
ID. When PositionFiltering is set to DistanceBased filtering, location data is stored
and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).
batchUpdateDevicePosition in interface AmazonLocationbatchUpdateDevicePositionRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public CalculateRouteResult calculateRoute(CalculateRouteRequest request)
Calculates a route
given the following required parameters: DeparturePostiton and DestinationPosition.
Requires that you first create a
route 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 a validation error.
Specifying
a travel mode using TravelMode. This lets you specify an additional route preference such as
CarModeOptions if traveling by Car, or TruckModeOptions if traveling by
Truck.
calculateRoute in interface AmazonLocationcalculateRouteRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest request)
Creates a geofence collection, which manages and stores geofences.
createGeofenceCollection in interface AmazonLocationcreateGeofenceCollectionRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.ConflictException - The request was unsuccessful because of a conflict.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public CreateMapResult createMap(CreateMapRequest request)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
createMap in interface AmazonLocationcreateMapRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.ConflictException - The request was unsuccessful because of a conflict.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest request)
Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other
text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by
using the SearchPlaceIndexForPosition operation.
createPlaceIndex in interface AmazonLocationcreatePlaceIndexRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.ConflictException - The request was unsuccessful because of a conflict.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public CreateRouteCalculatorResult createRouteCalculator(CreateRouteCalculatorRequest request)
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.
createRouteCalculator in interface AmazonLocationcreateRouteCalculatorRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.ConflictException - The request was unsuccessful because of a conflict.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public CreateTrackerResult createTracker(CreateTrackerRequest request)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
createTracker in interface AmazonLocationcreateTrackerRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.ConflictException - The request was unsuccessful because of a conflict.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest request)
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.
deleteGeofenceCollection in interface AmazonLocationdeleteGeofenceCollectionRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DeleteMapResult deleteMap(DeleteMapRequest request)
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.
deleteMap in interface AmazonLocationdeleteMapRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest request)
Deletes a place index resource from your AWS account.
This operation deletes the resource permanently.
deletePlaceIndex in interface AmazonLocationdeletePlaceIndexRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DeleteRouteCalculatorResult deleteRouteCalculator(DeleteRouteCalculatorRequest request)
Deletes a route calculator resource from your AWS account.
This operation deletes the resource permanently.
deleteRouteCalculator in interface AmazonLocationdeleteRouteCalculatorRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DeleteTrackerResult deleteTracker(DeleteTrackerRequest request)
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.
deleteTracker in interface AmazonLocationdeleteTrackerRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest request)
Retrieves the geofence collection details.
describeGeofenceCollection in interface AmazonLocationdescribeGeofenceCollectionRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DescribeMapResult describeMap(DescribeMapRequest request)
Retrieves the map resource details.
describeMap in interface AmazonLocationdescribeMapRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest request)
Retrieves the place index resource details.
describePlaceIndex in interface AmazonLocationdescribePlaceIndexRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DescribeRouteCalculatorResult describeRouteCalculator(DescribeRouteCalculatorRequest request)
Retrieves the route calculator resource details.
describeRouteCalculator in interface AmazonLocationdescribeRouteCalculatorRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DescribeTrackerResult describeTracker(DescribeTrackerRequest request)
Retrieves the tracker resource details.
describeTracker in interface AmazonLocationdescribeTrackerRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest request)
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.
disassociateTrackerConsumer in interface AmazonLocationdisassociateTrackerConsumerRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public GetDevicePositionResult getDevicePosition(GetDevicePositionRequest request)
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
getDevicePosition in interface AmazonLocationgetDevicePositionRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest request)
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
getDevicePositionHistory in interface AmazonLocationgetDevicePositionHistoryRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public GetGeofenceResult getGeofence(GetGeofenceRequest request)
Retrieves the geofence details from a geofence collection.
getGeofence in interface AmazonLocationgetGeofenceRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest request)
Retrieves glyphs used to display labels on a map.
getMapGlyphs in interface AmazonLocationgetMapGlyphsRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public GetMapSpritesResult getMapSprites(GetMapSpritesRequest request)
Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
getMapSprites in interface AmazonLocationgetMapSpritesRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest request)
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.
getMapStyleDescriptor in interface AmazonLocationgetMapStyleDescriptorRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public GetMapTileResult getMapTile(GetMapTileRequest request)
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they'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).
getMapTile in interface AmazonLocationgetMapTileRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public ListDevicePositionsResult listDevicePositions(ListDevicePositionsRequest request)
A batch request to retrieve all device positions.
listDevicePositions in interface AmazonLocationlistDevicePositionsRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest request)
Lists geofence collections in your AWS account.
listGeofenceCollections in interface AmazonLocationlistGeofenceCollectionsRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public ListGeofencesResult listGeofences(ListGeofencesRequest request)
Lists geofences stored in a given geofence collection.
listGeofences in interface AmazonLocationlistGeofencesRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public ListMapsResult listMaps(ListMapsRequest request)
Lists map resources in your AWS account.
listMaps in interface AmazonLocationlistMapsRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest request)
Lists place index resources in your AWS account.
listPlaceIndexes in interface AmazonLocationlistPlaceIndexesRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public ListRouteCalculatorsResult listRouteCalculators(ListRouteCalculatorsRequest request)
Lists route calculator resources in your AWS account.
listRouteCalculators in interface AmazonLocationlistRouteCalculatorsRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags that are applied to the specified Amazon Location resource.
listTagsForResource in interface AmazonLocationlistTagsForResourceRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest request)
Lists geofence collections currently associated to the given tracker resource.
listTrackerConsumers in interface AmazonLocationlistTrackerConsumersRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public ListTrackersResult listTrackers(ListTrackersRequest request)
Lists tracker resources in your AWS account.
listTrackers in interface AmazonLocationlistTrackersRequest - InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public PutGeofenceResult putGeofence(PutGeofenceRequest request)
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.
putGeofence in interface AmazonLocationputGeofenceRequest - 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 because of a conflict.AccessDeniedException - The request was denied because of insufficient access or permissions. 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 because of request throttling.public SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest request)
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
searchPlaceIndexForPosition in interface AmazonLocationsearchPlaceIndexForPositionRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest request)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
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.
Search results are returned in order of highest to lowest relevance.
searchPlaceIndexForText in interface AmazonLocationsearchPlaceIndexForTextRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public TagResourceResult tagResource(TagResourceRequest request)
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>You can use the <code>TagResource</code> operation 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's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p>
tagResource in interface AmazonLocationtagResourceRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the specified Amazon Location resource.
untagResource in interface AmazonLocationuntagResourceRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public UpdateGeofenceCollectionResult updateGeofenceCollection(UpdateGeofenceCollectionRequest request)
Updates the specified properties of a given geofence collection.
updateGeofenceCollection in interface AmazonLocationupdateGeofenceCollectionRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public UpdateMapResult updateMap(UpdateMapRequest request)
Updates the specified properties of a given map resource.
updateMap in interface AmazonLocationupdateMapRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public UpdatePlaceIndexResult updatePlaceIndex(UpdatePlaceIndexRequest request)
Updates the specified properties of a given place index resource.
updatePlaceIndex in interface AmazonLocationupdatePlaceIndexRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public UpdateRouteCalculatorResult updateRouteCalculator(UpdateRouteCalculatorRequest request)
Updates the specified properties for a given route calculator resource.
updateRouteCalculator in interface AmazonLocationupdateRouteCalculatorRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public UpdateTrackerResult updateTracker(UpdateTrackerRequest request)
Updates the specified properties of a given tracker resource.
updateTracker in interface AmazonLocationupdateTrackerRequest - 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 because of insufficient access or permissions. 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 because of request throttling.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonLocationrequest - The originally executed requestpublic void shutdown()
AmazonLocationshutdown in interface AmazonLocationshutdown in class AmazonWebServiceClientCopyright © 2021. All rights reserved.