@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonLocation extends Object implements AmazonLocation
AmazonLocation. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_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)
A batch request to retrieve all device positions.
|
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.
|
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, which supports functions with geospatial data sourced from
your chosen data provider.
|
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)
Lists the latest device positions for requested devices.
|
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 the tags for the specified Amazon Location Service 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 Service resource.
|
public AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest request)
AmazonLocationCreates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
associateTrackerConsumer in interface AmazonLocationpublic BatchDeleteDevicePositionHistoryResult batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest request)
AmazonLocationDeletes the position history of one or more devices from a tracker resource.
batchDeleteDevicePositionHistory in interface AmazonLocationpublic BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest request)
AmazonLocationDeletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
batchDeleteGeofence in interface AmazonLocationpublic BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest request)
AmazonLocationEvaluates device positions against the geofence geometries from a given geofence collection. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge.
The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update
batchEvaluateGeofences in interface AmazonLocationpublic BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest request)
AmazonLocationA batch request to retrieve all device positions.
batchGetDevicePosition in interface AmazonLocationpublic BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest request)
AmazonLocationA 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 AmazonLocationpublic BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest request)
AmazonLocationUploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history.
Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval and retained for 30 days before it's deleted.
batchUpdateDevicePosition in interface AmazonLocationpublic CalculateRouteResult calculateRoute(CalculateRouteRequest request)
AmazonLocation
Calculates a route
given the following required parameters: DeparturePostiton and DestinationPosition.
Requires that you first create
aroute calculator resource
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include:
Specifying a departure time using either DepartureTime or DepartureNow. This
calculates a route based on predictive traffic data at the given time.
You can't specify both DepartureTime and DepartureNow in a single request. Specifying
both parameters returns an error message.
Specifying
a travel mode using TravelMode. This lets you specify additional route preference such as
CarModeOptions if traveling by Car, or TruckModeOptions if traveling by
Truck.
calculateRoute in interface AmazonLocationpublic CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest request)
AmazonLocationCreates a geofence collection, which manages and stores geofences.
createGeofenceCollection in interface AmazonLocationpublic CreateMapResult createMap(CreateMapRequest request)
AmazonLocationCreates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
createMap in interface AmazonLocationpublic CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest request)
AmazonLocationCreates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider.
createPlaceIndex in interface AmazonLocationpublic CreateRouteCalculatorResult createRouteCalculator(CreateRouteCalculatorRequest request)
AmazonLocationCreates 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 AmazonLocationpublic CreateTrackerResult createTracker(CreateTrackerRequest request)
AmazonLocationCreates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
createTracker in interface AmazonLocationpublic DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest request)
AmazonLocationDeletes 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 AmazonLocationpublic DeleteMapResult deleteMap(DeleteMapRequest request)
AmazonLocationDeletes 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 AmazonLocationpublic DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest request)
AmazonLocationDeletes a place index resource from your AWS account.
This operation deletes the resource permanently.
deletePlaceIndex in interface AmazonLocationpublic DeleteRouteCalculatorResult deleteRouteCalculator(DeleteRouteCalculatorRequest request)
AmazonLocationDeletes a route calculator resource from your AWS account.
This operation deletes the resource permanently.
deleteRouteCalculator in interface AmazonLocationpublic DeleteTrackerResult deleteTracker(DeleteTrackerRequest request)
AmazonLocationDeletes 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 AmazonLocationpublic DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest request)
AmazonLocationRetrieves the geofence collection details.
describeGeofenceCollection in interface AmazonLocationpublic DescribeMapResult describeMap(DescribeMapRequest request)
AmazonLocationRetrieves the map resource details.
describeMap in interface AmazonLocationpublic DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest request)
AmazonLocationRetrieves the place index resource details.
describePlaceIndex in interface AmazonLocationpublic DescribeRouteCalculatorResult describeRouteCalculator(DescribeRouteCalculatorRequest request)
AmazonLocationRetrieves the route calculator resource details.
describeRouteCalculator in interface AmazonLocationpublic DescribeTrackerResult describeTracker(DescribeTrackerRequest request)
AmazonLocationRetrieves the tracker resource details.
describeTracker in interface AmazonLocationpublic DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest request)
AmazonLocationRemoves 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 AmazonLocationpublic GetDevicePositionResult getDevicePosition(GetDevicePositionRequest request)
AmazonLocationRetrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
getDevicePosition in interface AmazonLocationpublic GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest request)
AmazonLocationRetrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
getDevicePositionHistory in interface AmazonLocationpublic GetGeofenceResult getGeofence(GetGeofenceRequest request)
AmazonLocationRetrieves the geofence details from a geofence collection.
getGeofence in interface AmazonLocationpublic GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest request)
AmazonLocationRetrieves glyphs used to display labels on a map.
getMapGlyphs in interface AmazonLocationpublic GetMapSpritesResult getMapSprites(GetMapSpritesRequest request)
AmazonLocationRetrieves 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 AmazonLocationpublic GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest request)
AmazonLocationRetrieves 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 AmazonLocationpublic GetMapTileResult getMapTile(GetMapTileRequest request)
AmazonLocationRetrieves 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 AmazonLocationpublic ListDevicePositionsResult listDevicePositions(ListDevicePositionsRequest request)
AmazonLocationLists the latest device positions for requested devices.
listDevicePositions in interface AmazonLocationpublic ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest request)
AmazonLocationLists geofence collections in your AWS account.
listGeofenceCollections in interface AmazonLocationpublic ListGeofencesResult listGeofences(ListGeofencesRequest request)
AmazonLocationLists geofences stored in a given geofence collection.
listGeofences in interface AmazonLocationpublic ListMapsResult listMaps(ListMapsRequest request)
AmazonLocationLists map resources in your AWS account.
listMaps in interface AmazonLocationpublic ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest request)
AmazonLocationLists place index resources in your AWS account.
listPlaceIndexes in interface AmazonLocationpublic ListRouteCalculatorsResult listRouteCalculators(ListRouteCalculatorsRequest request)
AmazonLocationLists route calculator resources in your AWS account.
listRouteCalculators in interface AmazonLocationpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonLocationReturns the tags for the specified Amazon Location Service resource.
listTagsForResource in interface AmazonLocationpublic ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest request)
AmazonLocationLists geofence collections currently associated to the given tracker resource.
listTrackerConsumers in interface AmazonLocationpublic ListTrackersResult listTrackers(ListTrackersRequest request)
AmazonLocationLists tracker resources in your AWS account.
listTrackers in interface AmazonLocationpublic PutGeofenceResult putGeofence(PutGeofenceRequest request)
AmazonLocationStores 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 AmazonLocationpublic SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest request)
AmazonLocationReverse 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 AmazonLocationpublic SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest request)
AmazonLocationGeocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Includes the option to apply additional parameters to narrow your list of results.
You can search for places near a given position using BiasPosition, or filter results within a
bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
searchPlaceIndexForText in interface AmazonLocationpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonLocationAssigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
<p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate as many as 50 tags with a resource.</p>
tagResource in interface AmazonLocationpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonLocationRemoves one or more tags from the specified Amazon Location Service resource.
untagResource in interface AmazonLocationpublic void shutdown()
AmazonLocationshutdown in interface AmazonLocationpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonLocationResponse 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.
getCachedResponseMetadata in interface AmazonLocationrequest - The originally executed request.