@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonLocation
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"
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| 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)
Lists the latest device positions for requested devices.
|
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:
DeparturePosition and DestinationPosition. |
CalculateRouteMatrixResult |
calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)
Calculates a
route matrix given the following required parameters:
DeparturePositions and
DestinationPositions. |
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.
|
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.
|
GetPlaceResult |
getPlace(GetPlaceRequest getPlaceRequest)
Finds a place by its unique ID.
|
ListDevicePositionsResult |
listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)
A batch request to retrieve all device positions.
|
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 a list of tags that are applied to the specified Amazon Location 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.
|
SearchPlaceIndexForSuggestionsResult |
searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest)
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.
|
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 resource.
|
UpdateGeofenceCollectionResult |
updateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest)
Updates the specified properties of a given geofence collection.
|
UpdateMapResult |
updateMap(UpdateMapRequest updateMapRequest)
Updates the specified properties of a given map resource.
|
UpdatePlaceIndexResult |
updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest)
Updates the specified properties of a given place index resource.
|
UpdateRouteCalculatorResult |
updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest)
Updates the specified properties for a given route calculator resource.
|
UpdateTrackerResult |
updateTracker(UpdateTrackerRequest updateTrackerRequest)
Updates the specified properties of a given tracker resource.
|
static final String ENDPOINT_PREFIX
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.
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.
associateTrackerConsumerRequest - 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.BatchDeleteDevicePositionHistoryResult batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest)
Deletes the position history of one or more devices from a tracker resource.
batchDeleteDevicePositionHistoryRequest - 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.BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
batchDeleteGeofenceRequest - 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.BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
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.
Geofence evaluation uses the given device position. It does not account for the optional Accuracy of
a DevicePositionUpdate.
The DeviceID is used as a string to represent the device. You do not need to have a
Tracker associated with the DeviceID.
batchEvaluateGeofencesRequest - 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.BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
Lists the latest device positions for requested devices.
batchGetDevicePositionRequest - 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.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.
batchPutGeofenceRequest - 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.BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)
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).
When PositionFiltering is set to AccuracyBased filtering, location data is stored and
evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For
example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set
to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0}
when accuracy is not provided on a DevicePositionUpdate.
batchUpdateDevicePositionRequest - 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.CalculateRouteResult calculateRoute(CalculateRouteRequest calculateRouteRequest)
Calculates a route
given the following required parameters: DeparturePosition 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 DepartNow. This calculates a route based on
predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request. Specifying both
parameters returns a validation error.
Specifying a travel
mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
additional route preferences in CarModeOptions if traveling by Car, or
TruckModeOptions if traveling by Truck.
If you specify walking for the travel mode and your data provider is Esri, the start and destination
must be within 40km.
calculateRouteRequest - 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.CalculateRouteMatrixResult calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)
Calculates a
route matrix given the following required parameters: DeparturePositions and
DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel
time and travel distance from each departure position to each destination position in the request. For example,
given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will
return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of
results returned (and routes calculated) will be the number of DeparturePositions times the number
of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
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 routes.
Additional options include:
Specifying a departure
time using either DepartureTime or DepartNow. This calculates routes based on
predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request. Specifying both
parameters returns a validation error.
Specifying a travel
mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
additional route preferences in CarModeOptions if traveling by Car, or
TruckModeOptions if traveling by Truck.
calculateRouteMatrixRequest - 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.CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)
Creates a geofence collection, which manages and stores geofences.
createGeofenceCollectionRequest - 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.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.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
createMapRequest - 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.CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
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, and enable autosuggestions by using the
SearchPlaceIndexForSuggestions operation.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
createPlaceIndexRequest - 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.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.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
createRouteCalculatorRequest - 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.CreateTrackerResult createTracker(CreateTrackerRequest createTrackerRequest)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
createTrackerRequest - 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.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.
deleteGeofenceCollectionRequest - 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.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.
deleteMapRequest - 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.DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
Deletes a place index resource from your AWS account.
This operation deletes the resource permanently.
deletePlaceIndexRequest - 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.DeleteRouteCalculatorResult deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest)
Deletes a route calculator resource from your AWS account.
This operation deletes the resource permanently.
deleteRouteCalculatorRequest - 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.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.
deleteTrackerRequest - 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.DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)
Retrieves the geofence collection details.
describeGeofenceCollectionRequest - 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.DescribeMapResult describeMap(DescribeMapRequest describeMapRequest)
Retrieves the map resource details.
describeMapRequest - 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.DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
Retrieves the place index resource details.
describePlaceIndexRequest - 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.DescribeRouteCalculatorResult describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest)
Retrieves the route calculator resource details.
describeRouteCalculatorRequest - 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.DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrackerRequest)
Retrieves the tracker resource details.
describeTrackerRequest - 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.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.
disassociateTrackerConsumerRequest - 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.GetDevicePositionResult getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
getDevicePositionRequest - 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.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.
getDevicePositionHistoryRequest - 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.GetGeofenceResult getGeofence(GetGeofenceRequest getGeofenceRequest)
Retrieves the geofence details from a geofence collection.
getGeofenceRequest - 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.GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)
Retrieves glyphs used to display labels on a map.
getMapGlyphsRequest - 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.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.
getMapSpritesRequest - 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.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.
getMapStyleDescriptorRequest - 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.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).
getMapTileRequest - 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.GetPlaceResult getPlace(GetPlaceRequest getPlaceRequest)
Finds a place by its unique ID. A PlaceId is returned by other search operations.
A PlaceId is valid only if all of the following are the same in the original search request and the call to
GetPlace.
Customer AWS account
AWS Region
Data provider specified in the place index resource
getPlaceRequest - 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.ListDevicePositionsResult listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)
A batch request to retrieve all device positions.
listDevicePositionsRequest - 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.ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
listGeofenceCollectionsRequest - 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.ListGeofencesResult listGeofences(ListGeofencesRequest listGeofencesRequest)
Lists geofences stored in a given geofence collection.
listGeofencesRequest - 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.ListMapsResult listMaps(ListMapsRequest listMapsRequest)
Lists map resources in your AWS account.
listMapsRequest - 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.ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
Lists place index resources in your AWS account.
listPlaceIndexesRequest - 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.ListRouteCalculatorsResult listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
listRouteCalculatorsRequest - 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Location resource.
listTagsForResourceRequest - 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.ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
listTrackerConsumersRequest - 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.ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest)
Lists tracker resources in your AWS account.
listTrackersRequest - 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.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.
putGeofenceRequest - 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.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.
searchPlaceIndexForPositionRequest - 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.SearchPlaceIndexForSuggestionsResult searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest)
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.
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 suggested place names near a specified position by using BiasPosition, or filter
results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using
both BiasPosition and FilterBBox in the same command returns an error.
searchPlaceIndexForSuggestionsRequest - 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.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.
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.
searchPlaceIndexForTextRequest - 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.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>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>
tagResourceRequest - 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified Amazon Location resource.
untagResourceRequest - 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.UpdateGeofenceCollectionResult updateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest)
Updates the specified properties of a given geofence collection.
updateGeofenceCollectionRequest - 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.UpdateMapResult updateMap(UpdateMapRequest updateMapRequest)
Updates the specified properties of a given map resource.
updateMapRequest - 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.UpdatePlaceIndexResult updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest)
Updates the specified properties of a given place index resource.
updatePlaceIndexRequest - 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.UpdateRouteCalculatorResult updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest)
Updates the specified properties for a given route calculator resource.
updateRouteCalculatorRequest - 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.UpdateTrackerResult updateTracker(UpdateTrackerRequest updateTrackerRequest)
Updates the specified properties of a given tracker resource.
updateTrackerRequest - 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.void shutdown()
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 a request.
request - The originally executed request.