AmazonLocationClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.location.AmazonLocationClient

All Implemented Interfaces:

AmazonLocation

Direct Known Subclasses:

AmazonLocationAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonLocationClient
extends AmazonWebServiceClient
implements AmazonLocation
```
Client for accessing Amazon Location Service. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.location.AmazonLocation
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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).
`static AmazonLocationClientBuilder`	`builder()`
`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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonLocationClientBuilder builder()
```
  - associateTrackerConsumer
```
public AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest request)
```
    Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
    
    You can associate up to five geofence collections to each tracker resource.
    
    Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
    
    Specified by:
    
    associateTrackerConsumer in interface AmazonLocation
    
    Parameters:
    
    associateTrackerConsumerRequest -
    
    Returns:
    
    Result of the AssociateTrackerConsumer operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    ConflictException - The request was unsuccessful 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.
    
    See Also:
    
    AWS API Documentation
  - batchDeleteDevicePositionHistory
```
public BatchDeleteDevicePositionHistoryResult batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest request)
```
    Deletes the position history of one or more devices from a tracker resource.
    
    Specified by:
    
    batchDeleteDevicePositionHistory in interface AmazonLocation
    
    Parameters:
    
    batchDeleteDevicePositionHistoryRequest -
    
    Returns:
    
    Result of the BatchDeleteDevicePositionHistory operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - batchDeleteGeofence
```
public BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest request)
```
    Deletes a batch of geofences from a geofence collection.
    
    This operation deletes the resource permanently.
    
    Specified by:
    
    batchDeleteGeofence in interface AmazonLocation
    
    Parameters:
    
    batchDeleteGeofenceRequest -
    
    Returns:
    
    Result of the BatchDeleteGeofence operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - batchEvaluateGeofences
```
public BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest request)
```
    Evaluates device positions against the geofence geometries from a given geofence collection.
    
    This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:
    - ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
    - EXIT if Amazon Location determines that the tracked device has exited a geofenced area.
    The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.
    
    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.
    Specified by:
    
    batchEvaluateGeofences in interface AmazonLocation
    
    Parameters:
    
    batchEvaluateGeofencesRequest -
    
    Returns:
    
    Result of the BatchEvaluateGeofences operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - batchGetDevicePosition
```
public BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest request)
```
    Lists the latest device positions for requested devices.
    
    Specified by:
    
    batchGetDevicePosition in interface AmazonLocation
    
    Parameters:
    
    batchGetDevicePositionRequest -
    
    Returns:
    
    Result of the BatchGetDevicePosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - batchPutGeofence
```
public BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest request)
```
    A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
    
    Specified by:
    
    batchPutGeofence in interface AmazonLocation
    
    Parameters:
    
    batchPutGeofenceRequest -
    
    Returns:
    
    Result of the BatchPutGeofence operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - batchUpdateDevicePosition
```
public BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest request)
```
    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.
    
    Specified by:
    
    batchUpdateDevicePosition in interface AmazonLocation
    
    Parameters:
    
    batchUpdateDevicePositionRequest -
    
    Returns:
    
    Result of the BatchUpdateDevicePosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - calculateRoute
```
public CalculateRouteResult calculateRoute(CalculateRouteRequest request)
```
    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.
    Specified by:
    
    calculateRoute in interface AmazonLocation
    
    Parameters:
    
    calculateRouteRequest -
    
    Returns:
    
    Result of the CalculateRoute operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - calculateRouteMatrix
```
public CalculateRouteMatrixResult calculateRouteMatrix(CalculateRouteMatrixRequest request)
```
    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.
    Specified by:
    
    calculateRouteMatrix in interface AmazonLocation
    
    Parameters:
    
    calculateRouteMatrixRequest -
    
    Returns:
    
    Result of the CalculateRouteMatrix operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - createGeofenceCollection
```
public CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest request)
```
    Creates a geofence collection, which manages and stores geofences.
    
    Specified by:
    
    createGeofenceCollection in interface AmazonLocation
    
    Parameters:
    
    createGeofenceCollectionRequest -
    
    Returns:
    
    Result of the CreateGeofenceCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful 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.
    
    See Also:
    
    AWS API Documentation
  - createKey
```
public 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.
    
    For more information, see Using API keys.
    
    Specified by:
    
    createKey in interface AmazonLocation
    
    Parameters:
    
    createKeyRequest -
    
    Returns:
    
    Result of the CreateKey operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful 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.
    
    See Also:
    
    AWS API Documentation
  - createMap
```
public 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.
    
    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.
    
    Specified by:
    
    createMap in interface AmazonLocation
    
    Parameters:
    
    createMapRequest -
    
    Returns:
    
    Result of the CreateMap operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful 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.
    
    See Also:
    
    AWS API Documentation
  - createPlaceIndex
```
public CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest request)
```
    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.
    
    Specified by:
    
    createPlaceIndex in interface AmazonLocation
    
    Parameters:
    
    createPlaceIndexRequest -
    
    Returns:
    
    Result of the CreatePlaceIndex operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful 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.
    
    See Also:
    
    AWS API Documentation
  - createRouteCalculator
```
public CreateRouteCalculatorResult createRouteCalculator(CreateRouteCalculatorRequest request)
```
    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.
    
    Specified by:
    
    createRouteCalculator in interface AmazonLocation
    
    Parameters:
    
    createRouteCalculatorRequest -
    
    Returns:
    
    Result of the CreateRouteCalculator operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful 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.
    
    See Also:
    
    AWS API Documentation
  - createTracker
```
public CreateTrackerResult createTracker(CreateTrackerRequest request)
```
    Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
    
    Specified by:
    
    createTracker in interface AmazonLocation
    
    Parameters:
    
    createTrackerRequest -
    
    Returns:
    
    Result of the CreateTracker operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ConflictException - The request was unsuccessful 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.
    
    See Also:
    
    AWS API Documentation
  - deleteGeofenceCollection
```
public DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest request)
```
    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.
    
    Specified by:
    
    deleteGeofenceCollection in interface AmazonLocation
    
    Parameters:
    
    deleteGeofenceCollectionRequest -
    
    Returns:
    
    Result of the DeleteGeofenceCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - deleteKey
```
public DeleteKeyResult deleteKey(DeleteKeyRequest request)
```
    Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
    
    Specified by:
    
    deleteKey in interface AmazonLocation
    
    Parameters:
    
    deleteKeyRequest -
    
    Returns:
    
    Result of the DeleteKey operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - deleteMap
```
public DeleteMapResult deleteMap(DeleteMapRequest request)
```
    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.
    
    Specified by:
    
    deleteMap in interface AmazonLocation
    
    Parameters:
    
    deleteMapRequest -
    
    Returns:
    
    Result of the DeleteMap operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - deletePlaceIndex
```
public DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest request)
```
    Deletes a place index resource from your Amazon Web Services account.
    
    This operation deletes the resource permanently.
    
    Specified by:
    
    deletePlaceIndex in interface AmazonLocation
    
    Parameters:
    
    deletePlaceIndexRequest -
    
    Returns:
    
    Result of the DeletePlaceIndex operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - deleteRouteCalculator
```
public DeleteRouteCalculatorResult deleteRouteCalculator(DeleteRouteCalculatorRequest request)
```
    Deletes a route calculator resource from your Amazon Web Services account.
    
    This operation deletes the resource permanently.
    
    Specified by:
    
    deleteRouteCalculator in interface AmazonLocation
    
    Parameters:
    
    deleteRouteCalculatorRequest -
    
    Returns:
    
    Result of the DeleteRouteCalculator operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - deleteTracker
```
public DeleteTrackerResult deleteTracker(DeleteTrackerRequest request)
```
    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.
    
    Specified by:
    
    deleteTracker in interface AmazonLocation
    
    Parameters:
    
    deleteTrackerRequest -
    
    Returns:
    
    Result of the DeleteTracker operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - describeGeofenceCollection
```
public DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest request)
```
    Retrieves the geofence collection details.
    
    Specified by:
    
    describeGeofenceCollection in interface AmazonLocation
    
    Parameters:
    
    describeGeofenceCollectionRequest -
    
    Returns:
    
    Result of the DescribeGeofenceCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - describeKey
```
public DescribeKeyResult describeKey(DescribeKeyRequest request)
```
    Retrieves the API key resource details.
    
    Specified by:
    
    describeKey in interface AmazonLocation
    
    Parameters:
    
    describeKeyRequest -
    
    Returns:
    
    Result of the DescribeKey operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - describeMap
```
public DescribeMapResult describeMap(DescribeMapRequest request)
```
    Retrieves the map resource details.
    
    Specified by:
    
    describeMap in interface AmazonLocation
    
    Parameters:
    
    describeMapRequest -
    
    Returns:
    
    Result of the DescribeMap operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - describePlaceIndex
```
public DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest request)
```
    Retrieves the place index resource details.
    
    Specified by:
    
    describePlaceIndex in interface AmazonLocation
    
    Parameters:
    
    describePlaceIndexRequest -
    
    Returns:
    
    Result of the DescribePlaceIndex operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - describeRouteCalculator
```
public DescribeRouteCalculatorResult describeRouteCalculator(DescribeRouteCalculatorRequest request)
```
    Retrieves the route calculator resource details.
    
    Specified by:
    
    describeRouteCalculator in interface AmazonLocation
    
    Parameters:
    
    describeRouteCalculatorRequest -
    
    Returns:
    
    Result of the DescribeRouteCalculator operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - describeTracker
```
public DescribeTrackerResult describeTracker(DescribeTrackerRequest request)
```
    Retrieves the tracker resource details.
    
    Specified by:
    
    describeTracker in interface AmazonLocation
    
    Parameters:
    
    describeTrackerRequest -
    
    Returns:
    
    Result of the DescribeTracker operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - disassociateTrackerConsumer
```
public DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest request)
```
    Removes the association between a tracker resource and a geofence collection.
    
    Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
    
    Specified by:
    
    disassociateTrackerConsumer in interface AmazonLocation
    
    Parameters:
    
    disassociateTrackerConsumerRequest -
    
    Returns:
    
    Result of the DisassociateTrackerConsumer operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - forecastGeofenceEvents
```
public ForecastGeofenceEventsResult forecastGeofenceEvents(ForecastGeofenceEventsRequest request)
```
    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.
    
    Specified by:
    
    forecastGeofenceEvents in interface AmazonLocation
    
    Parameters:
    
    forecastGeofenceEventsRequest -
    
    Returns:
    
    Result of the ForecastGeofenceEvents operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getDevicePosition
```
public GetDevicePositionResult getDevicePosition(GetDevicePositionRequest request)
```
    Retrieves a device's most recent position according to its sample time.
    
    Device positions are deleted after 30 days.
    
    Specified by:
    
    getDevicePosition in interface AmazonLocation
    
    Parameters:
    
    getDevicePositionRequest -
    
    Returns:
    
    Result of the GetDevicePosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getDevicePositionHistory
```
public GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest request)
```
    Retrieves the device position history from a tracker resource within a specified range of time.
    
    Device positions are deleted after 30 days.
    
    Specified by:
    
    getDevicePositionHistory in interface AmazonLocation
    
    Parameters:
    
    getDevicePositionHistoryRequest -
    
    Returns:
    
    Result of the GetDevicePositionHistory operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getGeofence
```
public GetGeofenceResult getGeofence(GetGeofenceRequest request)
```
    Retrieves the geofence details from a geofence collection.
    
    The returned geometry will always match the geometry format used when the geofence was created.
    
    Specified by:
    
    getGeofence in interface AmazonLocation
    
    Parameters:
    
    getGeofenceRequest -
    
    Returns:
    
    Result of the GetGeofence operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getMapGlyphs
```
public GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest request)
```
    Retrieves glyphs used to display labels on a map.
    
    Specified by:
    
    getMapGlyphs in interface AmazonLocation
    
    Parameters:
    
    getMapGlyphsRequest -
    
    Returns:
    
    Result of the GetMapGlyphs operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getMapSprites
```
public GetMapSpritesResult getMapSprites(GetMapSpritesRequest request)
```
    Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
    
    Specified by:
    
    getMapSprites in interface AmazonLocation
    
    Parameters:
    
    getMapSpritesRequest -
    
    Returns:
    
    Result of the GetMapSprites operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getMapStyleDescriptor
```
public GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest request)
```
    Retrieves the map style descriptor from a map resource.
    
    The style descriptor contains speciﬁcations 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.
    
    Specified by:
    
    getMapStyleDescriptor in interface AmazonLocation
    
    Parameters:
    
    getMapStyleDescriptorRequest -
    
    Returns:
    
    Result of the GetMapStyleDescriptor operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getMapTile
```
public GetMapTileResult getMapTile(GetMapTileRequest request)
```
    Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
    
    The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
    
    Specified by:
    
    getMapTile in interface AmazonLocation
    
    Parameters:
    
    getMapTileRequest -
    
    Returns:
    
    Result of the GetMapTile operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getPlace
```
public GetPlaceResult getPlace(GetPlaceRequest request)
```
    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
    Specified by:
    
    getPlace in interface AmazonLocation
    
    Parameters:
    
    getPlaceRequest -
    
    Returns:
    
    Result of the GetPlace operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listDevicePositions
```
public ListDevicePositionsResult listDevicePositions(ListDevicePositionsRequest request)
```
    A batch request to retrieve all device positions.
    
    Specified by:
    
    listDevicePositions in interface AmazonLocation
    
    Parameters:
    
    listDevicePositionsRequest -
    
    Returns:
    
    Result of the ListDevicePositions operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listGeofenceCollections
```
public ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest request)
```
    Lists geofence collections in your Amazon Web Services account.
    
    Specified by:
    
    listGeofenceCollections in interface AmazonLocation
    
    Parameters:
    
    listGeofenceCollectionsRequest -
    
    Returns:
    
    Result of the ListGeofenceCollections operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listGeofences
```
public ListGeofencesResult listGeofences(ListGeofencesRequest request)
```
    Lists geofences stored in a given geofence collection.
    
    Specified by:
    
    listGeofences in interface AmazonLocation
    
    Parameters:
    
    listGeofencesRequest -
    
    Returns:
    
    Result of the ListGeofences operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listKeys
```
public ListKeysResult listKeys(ListKeysRequest request)
```
    Lists API key resources in your Amazon Web Services account.
    
    Specified by:
    
    listKeys in interface AmazonLocation
    
    Parameters:
    
    listKeysRequest -
    
    Returns:
    
    Result of the ListKeys operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listMaps
```
public ListMapsResult listMaps(ListMapsRequest request)
```
    Lists map resources in your Amazon Web Services account.
    
    Specified by:
    
    listMaps in interface AmazonLocation
    
    Parameters:
    
    listMapsRequest -
    
    Returns:
    
    Result of the ListMaps operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listPlaceIndexes
```
public ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest request)
```
    Lists place index resources in your Amazon Web Services account.
    
    Specified by:
    
    listPlaceIndexes in interface AmazonLocation
    
    Parameters:
    
    listPlaceIndexesRequest -
    
    Returns:
    
    Result of the ListPlaceIndexes operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listRouteCalculators
```
public ListRouteCalculatorsResult listRouteCalculators(ListRouteCalculatorsRequest request)
```
    Lists route calculator resources in your Amazon Web Services account.
    
    Specified by:
    
    listRouteCalculators in interface AmazonLocation
    
    Parameters:
    
    listRouteCalculatorsRequest -
    
    Returns:
    
    Result of the ListRouteCalculators operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns a list of tags that are applied to the specified Amazon Location resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonLocation
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listTrackerConsumers
```
public ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest request)
```
    Lists geofence collections currently associated to the given tracker resource.
    
    Specified by:
    
    listTrackerConsumers in interface AmazonLocation
    
    Parameters:
    
    listTrackerConsumersRequest -
    
    Returns:
    
    Result of the ListTrackerConsumers operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - listTrackers
```
public ListTrackersResult listTrackers(ListTrackersRequest request)
```
    Lists tracker resources in your Amazon Web Services account.
    
    Specified by:
    
    listTrackers in interface AmazonLocation
    
    Parameters:
    
    listTrackersRequest -
    
    Returns:
    
    Result of the ListTrackers operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - putGeofence
```
public PutGeofenceResult putGeofence(PutGeofenceRequest request)
```
    Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
    
    Specified by:
    
    putGeofence in interface AmazonLocation
    
    Parameters:
    
    putGeofenceRequest -
    
    Returns:
    
    Result of the PutGeofence operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    ConflictException - The request was unsuccessful 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.
    
    See Also:
    
    AWS API Documentation
  - searchPlaceIndexForPosition
```
public SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest request)
```
    Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
    
    Specified by:
    
    searchPlaceIndexForPosition in interface AmazonLocation
    
    Parameters:
    
    searchPlaceIndexForPositionRequest -
    
    Returns:
    
    Result of the SearchPlaceIndexForPosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - searchPlaceIndexForSuggestions
```
public SearchPlaceIndexForSuggestionsResult searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest request)
```
    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.
    
    Specified by:
    
    searchPlaceIndexForSuggestions in interface AmazonLocation
    
    Parameters:
    
    searchPlaceIndexForSuggestionsRequest -
    
    Returns:
    
    Result of the SearchPlaceIndexForSuggestions operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - searchPlaceIndexForText
```
public SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest request)
```
    Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
    
    Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
    
    You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
    
    Search results are returned in order of highest to lowest relevance.
    
    Specified by:
    
    searchPlaceIndexForText in interface AmazonLocation
    
    Parameters:
    
    searchPlaceIndexForTextRequest -
    
    Returns:
    
    Result of the SearchPlaceIndexForText operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AmazonLocation
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes one or more tags from the specified Amazon Location resource.
    
    Specified by:
    
    untagResource in interface AmazonLocation
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - updateGeofenceCollection
```
public UpdateGeofenceCollectionResult updateGeofenceCollection(UpdateGeofenceCollectionRequest request)
```
    Updates the specified properties of a given geofence collection.
    
    Specified by:
    
    updateGeofenceCollection in interface AmazonLocation
    
    Parameters:
    
    updateGeofenceCollectionRequest -
    
    Returns:
    
    Result of the UpdateGeofenceCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - updateKey
```
public UpdateKeyResult updateKey(UpdateKeyRequest request)
```
    Updates the specified properties of a given API key resource.
    
    Specified by:
    
    updateKey in interface AmazonLocation
    
    Parameters:
    
    updateKeyRequest -
    
    Returns:
    
    Result of the UpdateKey operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - updateMap
```
public UpdateMapResult updateMap(UpdateMapRequest request)
```
    Updates the specified properties of a given map resource.
    
    Specified by:
    
    updateMap in interface AmazonLocation
    
    Parameters:
    
    updateMapRequest -
    
    Returns:
    
    Result of the UpdateMap operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - updatePlaceIndex
```
public UpdatePlaceIndexResult updatePlaceIndex(UpdatePlaceIndexRequest request)
```
    Updates the specified properties of a given place index resource.
    
    Specified by:
    
    updatePlaceIndex in interface AmazonLocation
    
    Parameters:
    
    updatePlaceIndexRequest -
    
    Returns:
    
    Result of the UpdatePlaceIndex operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - updateRouteCalculator
```
public UpdateRouteCalculatorResult updateRouteCalculator(UpdateRouteCalculatorRequest request)
```
    Updates the specified properties for a given route calculator resource.
    
    Specified by:
    
    updateRouteCalculator in interface AmazonLocation
    
    Parameters:
    
    updateRouteCalculatorRequest -
    
    Returns:
    
    Result of the UpdateRouteCalculator operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - updateTracker
```
public UpdateTrackerResult updateTracker(UpdateTrackerRequest request)
```
    Updates the specified properties of a given tracker resource.
    
    Specified by:
    
    updateTracker in interface AmazonLocation
    
    Parameters:
    
    updateTrackerRequest -
    
    Returns:
    
    Result of the UpdateTracker operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - verifyDevicePosition
```
public 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.
    
    Specified by:
    
    verifyDevicePosition in interface AmazonLocation
    
    Parameters:
    
    verifyDevicePositionRequest -
    
    Returns:
    
    Result of the VerifyDevicePosition operation returned by the service.
    
    Throws:
    
    InternalServerException - The request has failed to process because of an unknown server error, exception, or failure.
    
    ResourceNotFoundException - The resource that you've entered was not found in your AWS account.
    
    AccessDeniedException - The request was denied 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.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonLocation
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonLocation
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

AWS SDK for Java 1.x API Reference - 1.12.793

Class AmazonLocationClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.location.AmazonLocation

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

associateTrackerConsumer

batchDeleteDevicePositionHistory

batchDeleteGeofence

batchEvaluateGeofences

batchGetDevicePosition

batchPutGeofence

batchUpdateDevicePosition

calculateRoute

calculateRouteMatrix

createGeofenceCollection

createKey

createMap

createPlaceIndex

createRouteCalculator

createTracker

deleteGeofenceCollection

deleteKey

deleteMap

deletePlaceIndex

deleteRouteCalculator

deleteTracker

describeGeofenceCollection

describeKey

describeMap

describePlaceIndex

describeRouteCalculator

describeTracker

disassociateTrackerConsumer

forecastGeofenceEvents

getDevicePosition

getDevicePositionHistory

getGeofence

getMapGlyphs

getMapSprites

getMapStyleDescriptor

getMapTile

getPlace

listDevicePositions

listGeofenceCollections

listGeofences

listKeys

listMaps

listPlaceIndexes

listRouteCalculators

listTagsForResource

listTrackerConsumers

listTrackers

putGeofence

searchPlaceIndexForPosition

searchPlaceIndexForSuggestions

searchPlaceIndexForText

tagResource

untagResource

updateGeofenceCollection

updateKey

updateMap

updatePlaceIndex

updateRouteCalculator

updateTracker

verifyDevicePosition

getCachedResponseMetadata

shutdown