@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)
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 (up to 10 devices per batch).
|
CalculateRouteResult |
calculateRoute(CalculateRouteRequest request)
Calculates a route
given the following required parameters:
DeparturePosition and DestinationPosition . |
CalculateRouteMatrixResult |
calculateRouteMatrix(CalculateRouteMatrixRequest request)
Calculates a
route matrix given the following required parameters:
DeparturePositions and
DestinationPositions . |
CreateGeofenceCollectionResult |
createGeofenceCollection(CreateGeofenceCollectionRequest request)
Creates a geofence collection, which manages and stores geofences.
|
CreateKeyResult |
createKey(CreateKeyRequest request)
Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location
resources to the API key bearer.
|
CreateMapResult |
createMap(CreateMapRequest request)
Creates a map resource in your Amazon Web Services 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 Amazon Web Services account.
|
CreateRouteCalculatorResult |
createRouteCalculator(CreateRouteCalculatorRequest request)
Creates a route calculator resource in your Amazon Web Services account.
|
CreateTrackerResult |
createTracker(CreateTrackerRequest request)
Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical
location of devices.
|
DeleteGeofenceCollectionResult |
deleteGeofenceCollection(DeleteGeofenceCollectionRequest request)
Deletes a geofence collection from your Amazon Web Services account.
|
DeleteKeyResult |
deleteKey(DeleteKeyRequest request)
Deletes the specified API key.
|
DeleteMapResult |
deleteMap(DeleteMapRequest request)
Deletes a map resource from your Amazon Web Services account.
|
DeletePlaceIndexResult |
deletePlaceIndex(DeletePlaceIndexRequest request)
Deletes a place index resource from your Amazon Web Services account.
|
DeleteRouteCalculatorResult |
deleteRouteCalculator(DeleteRouteCalculatorRequest request)
Deletes a route calculator resource from your Amazon Web Services account.
|
DeleteTrackerResult |
deleteTracker(DeleteTrackerRequest request)
Deletes a tracker resource from your Amazon Web Services account.
|
DescribeGeofenceCollectionResult |
describeGeofenceCollection(DescribeGeofenceCollectionRequest request)
Retrieves the geofence collection details.
|
DescribeKeyResult |
describeKey(DescribeKeyRequest request)
Retrieves the API key resource 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.
|
ForecastGeofenceEventsResult |
forecastGeofenceEvents(ForecastGeofenceEventsRequest request)
Evaluates device positions against geofence geometries from a given 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.
|
GetPlaceResult |
getPlace(GetPlaceRequest request)
Finds a place by its unique ID.
|
ListDevicePositionsResult |
listDevicePositions(ListDevicePositionsRequest request)
A batch request to retrieve all device positions.
|
ListGeofenceCollectionsResult |
listGeofenceCollections(ListGeofenceCollectionsRequest request)
Lists geofence collections in your Amazon Web Services account.
|
ListGeofencesResult |
listGeofences(ListGeofencesRequest request)
Lists geofences stored in a given geofence collection.
|
ListKeysResult |
listKeys(ListKeysRequest request)
Lists API key resources in your Amazon Web Services account.
|
ListMapsResult |
listMaps(ListMapsRequest request)
Lists map resources in your Amazon Web Services account.
|
ListPlaceIndexesResult |
listPlaceIndexes(ListPlaceIndexesRequest request)
Lists place index resources in your Amazon Web Services account.
|
ListRouteCalculatorsResult |
listRouteCalculators(ListRouteCalculatorsRequest request)
Lists route calculator resources in your Amazon Web Services 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 Amazon Web Services 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.
|
SearchPlaceIndexForSuggestionsResult |
searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest request)
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.
|
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.
|
UpdateKeyResult |
updateKey(UpdateKeyRequest request)
Updates the specified properties of a given API key resource.
|
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.
|
VerifyDevicePositionResult |
verifyDevicePosition(VerifyDevicePositionRequest request)
Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by
comparing it to an inferred position estimated based on the device's state.
|
public AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest request)
AmazonLocation
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 AmazonLocation
public BatchDeleteDevicePositionHistoryResult batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest request)
AmazonLocation
Deletes the position history of one or more devices from a tracker resource.
batchDeleteDevicePositionHistory
in interface AmazonLocation
public BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest request)
AmazonLocation
Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
batchDeleteGeofence
in interface AmazonLocation
public BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest request)
AmazonLocation
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
.
batchEvaluateGeofences
in interface AmazonLocation
public BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest request)
AmazonLocation
Lists the latest device positions for requested devices.
batchGetDevicePosition
in interface AmazonLocation
public BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest request)
AmazonLocation
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 AmazonLocation
public BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest request)
AmazonLocation
Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). 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
.
batchUpdateDevicePosition
in interface AmazonLocation
public CalculateRouteResult calculateRoute(CalculateRouteRequest request)
AmazonLocation
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.
calculateRoute
in interface AmazonLocation
public CalculateRouteMatrixResult calculateRouteMatrix(CalculateRouteMatrixRequest request)
AmazonLocation
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
.
calculateRouteMatrix
in interface AmazonLocation
public CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest request)
AmazonLocation
Creates a geofence collection, which manages and stores geofences.
createGeofenceCollection
in interface AmazonLocation
public CreateKeyResult createKey(CreateKeyRequest request)
AmazonLocation
Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.
For more information, see Using API keys.
createKey
in interface AmazonLocation
public CreateMapResult createMap(CreateMapRequest request)
AmazonLocation
Creates a map resource in your Amazon Web Services 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 must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
createMap
in interface AmazonLocation
public CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest request)
AmazonLocation
Creates a place index resource in your Amazon Web Services 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 must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
createPlaceIndex
in interface AmazonLocation
public CreateRouteCalculatorResult createRouteCalculator(CreateRouteCalculatorRequest request)
AmazonLocation
Creates a route calculator resource in your Amazon Web Services 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 must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
createRouteCalculator
in interface AmazonLocation
public CreateTrackerResult createTracker(CreateTrackerRequest request)
AmazonLocation
Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
createTracker
in interface AmazonLocation
public DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest request)
AmazonLocation
Deletes a geofence collection from your Amazon Web Services 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 AmazonLocation
public DeleteKeyResult deleteKey(DeleteKeyRequest request)
AmazonLocation
Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
deleteKey
in interface AmazonLocation
public DeleteMapResult deleteMap(DeleteMapRequest request)
AmazonLocation
Deletes a map resource from your Amazon Web Services account.
This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
deleteMap
in interface AmazonLocation
public DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest request)
AmazonLocation
Deletes a place index resource from your Amazon Web Services account.
This operation deletes the resource permanently.
deletePlaceIndex
in interface AmazonLocation
public DeleteRouteCalculatorResult deleteRouteCalculator(DeleteRouteCalculatorRequest request)
AmazonLocation
Deletes a route calculator resource from your Amazon Web Services account.
This operation deletes the resource permanently.
deleteRouteCalculator
in interface AmazonLocation
public DeleteTrackerResult deleteTracker(DeleteTrackerRequest request)
AmazonLocation
Deletes a tracker resource from your Amazon Web Services 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 AmazonLocation
public DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest request)
AmazonLocation
Retrieves the geofence collection details.
describeGeofenceCollection
in interface AmazonLocation
public DescribeKeyResult describeKey(DescribeKeyRequest request)
AmazonLocation
Retrieves the API key resource details.
describeKey
in interface AmazonLocation
public DescribeMapResult describeMap(DescribeMapRequest request)
AmazonLocation
Retrieves the map resource details.
describeMap
in interface AmazonLocation
public DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest request)
AmazonLocation
Retrieves the place index resource details.
describePlaceIndex
in interface AmazonLocation
public DescribeRouteCalculatorResult describeRouteCalculator(DescribeRouteCalculatorRequest request)
AmazonLocation
Retrieves the route calculator resource details.
describeRouteCalculator
in interface AmazonLocation
public DescribeTrackerResult describeTracker(DescribeTrackerRequest request)
AmazonLocation
Retrieves the tracker resource details.
describeTracker
in interface AmazonLocation
public DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest request)
AmazonLocation
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 AmazonLocation
public ForecastGeofenceEventsResult forecastGeofenceEvents(ForecastGeofenceEventsRequest request)
AmazonLocation
Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts three states for which a device can be in relative to a geofence:
ENTER
: If a device is outside of a geofence, but would breach the fence if the device is moving at
its current speed within time horizon window.
EXIT
: If a device is inside of a geofence, but would breach the fence if the device is moving at its
current speed within time horizon window.
IDLE
: If a device is inside of a geofence, and the device is not moving.
forecastGeofenceEvents
in interface AmazonLocation
public GetDevicePositionResult getDevicePosition(GetDevicePositionRequest request)
AmazonLocation
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
getDevicePosition
in interface AmazonLocation
public GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest request)
AmazonLocation
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 AmazonLocation
public GetGeofenceResult getGeofence(GetGeofenceRequest request)
AmazonLocation
Retrieves the geofence details from a geofence collection.
The returned geometry will always match the geometry format used when the geofence was created.
getGeofence
in interface AmazonLocation
public GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest request)
AmazonLocation
Retrieves glyphs used to display labels on a map.
getMapGlyphs
in interface AmazonLocation
public GetMapSpritesResult getMapSprites(GetMapSpritesRequest request)
AmazonLocation
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 AmazonLocation
public GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest request)
AmazonLocation
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 AmazonLocation
public GetMapTileResult getMapTile(GetMapTileRequest request)
AmazonLocation
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 AmazonLocation
public GetPlaceResult getPlace(GetPlaceRequest request)
AmazonLocation
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 Amazon Web Services account
Amazon Web Services Region
Data provider specified in the place index resource
getPlace
in interface AmazonLocation
public ListDevicePositionsResult listDevicePositions(ListDevicePositionsRequest request)
AmazonLocation
A batch request to retrieve all device positions.
listDevicePositions
in interface AmazonLocation
public ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest request)
AmazonLocation
Lists geofence collections in your Amazon Web Services account.
listGeofenceCollections
in interface AmazonLocation
public ListGeofencesResult listGeofences(ListGeofencesRequest request)
AmazonLocation
Lists geofences stored in a given geofence collection.
listGeofences
in interface AmazonLocation
public ListKeysResult listKeys(ListKeysRequest request)
AmazonLocation
Lists API key resources in your Amazon Web Services account.
listKeys
in interface AmazonLocation
public ListMapsResult listMaps(ListMapsRequest request)
AmazonLocation
Lists map resources in your Amazon Web Services account.
listMaps
in interface AmazonLocation
public ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest request)
AmazonLocation
Lists place index resources in your Amazon Web Services account.
listPlaceIndexes
in interface AmazonLocation
public ListRouteCalculatorsResult listRouteCalculators(ListRouteCalculatorsRequest request)
AmazonLocation
Lists route calculator resources in your Amazon Web Services account.
listRouteCalculators
in interface AmazonLocation
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonLocation
Returns a list of tags that are applied to the specified Amazon Location resource.
listTagsForResource
in interface AmazonLocation
public ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest request)
AmazonLocation
Lists geofence collections currently associated to the given tracker resource.
listTrackerConsumers
in interface AmazonLocation
public ListTrackersResult listTrackers(ListTrackersRequest request)
AmazonLocation
Lists tracker resources in your Amazon Web Services account.
listTrackers
in interface AmazonLocation
public PutGeofenceResult putGeofence(PutGeofenceRequest request)
AmazonLocation
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 AmazonLocation
public SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest request)
AmazonLocation
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 AmazonLocation
public SearchPlaceIndexForSuggestionsResult searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest request)
AmazonLocation
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.
searchPlaceIndexForSuggestions
in interface AmazonLocation
public SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest request)
AmazonLocation
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 AmazonLocation
public TagResourceResult tagResource(TagResourceRequest request)
AmazonLocation
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
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.
You can use the TagResource
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.
You can associate up to 50 tags with a resource.
tagResource
in interface AmazonLocation
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonLocation
Removes one or more tags from the specified Amazon Location resource.
untagResource
in interface AmazonLocation
public UpdateGeofenceCollectionResult updateGeofenceCollection(UpdateGeofenceCollectionRequest request)
AmazonLocation
Updates the specified properties of a given geofence collection.
updateGeofenceCollection
in interface AmazonLocation
public UpdateKeyResult updateKey(UpdateKeyRequest request)
AmazonLocation
Updates the specified properties of a given API key resource.
updateKey
in interface AmazonLocation
public UpdateMapResult updateMap(UpdateMapRequest request)
AmazonLocation
Updates the specified properties of a given map resource.
updateMap
in interface AmazonLocation
public UpdatePlaceIndexResult updatePlaceIndex(UpdatePlaceIndexRequest request)
AmazonLocation
Updates the specified properties of a given place index resource.
updatePlaceIndex
in interface AmazonLocation
public UpdateRouteCalculatorResult updateRouteCalculator(UpdateRouteCalculatorRequest request)
AmazonLocation
Updates the specified properties for a given route calculator resource.
updateRouteCalculator
in interface AmazonLocation
public UpdateTrackerResult updateTracker(UpdateTrackerRequest request)
AmazonLocation
Updates the specified properties of a given tracker resource.
updateTracker
in interface AmazonLocation
public VerifyDevicePositionResult verifyDevicePosition(VerifyDevicePositionRequest request)
AmazonLocation
Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.
verifyDevicePosition
in interface AmazonLocation
public void shutdown()
AmazonLocation
shutdown
in interface AmazonLocation
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonLocation
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.
getCachedResponseMetadata
in interface AmazonLocation
request
- The originally executed request.