AmazonLocation (AWS Java SDK for Amazon Location 1.12.788 API)

All Known Subinterfaces:

AmazonLocationAsync

All Known Implementing Classes:

AbstractAmazonLocation, AbstractAmazonLocationAsync, AmazonLocationAsyncClient, AmazonLocationClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLocation
```
Interface for accessing Amazon Location Service.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonLocation instead.

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

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateTrackerConsumerResult`	`associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)` Creates an association between a geofence collection and a tracker resource.
`BatchDeleteDevicePositionHistoryResult`	`batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest)` Deletes the position history of one or more devices from a tracker resource.
`BatchDeleteGeofenceResult`	`batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)` Deletes a batch of geofences from a geofence collection.
`BatchEvaluateGeofencesResult`	`batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)` Evaluates device positions against the geofence geometries from a given geofence collection.
`BatchGetDevicePositionResult`	`batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)` Lists the latest device positions for requested devices.
`BatchPutGeofenceResult`	`batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)` A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
`BatchUpdateDevicePositionResult`	`batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)` Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).
`CalculateRouteResult`	`calculateRoute(CalculateRouteRequest calculateRouteRequest)` Calculates a route given the following required parameters: `DeparturePosition` and `DestinationPosition`.
`CalculateRouteMatrixResult`	`calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)` Calculates a route matrix given the following required parameters: `DeparturePositions` and `DestinationPositions`.
`CreateGeofenceCollectionResult`	`createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)` Creates a geofence collection, which manages and stores geofences.
`CreateKeyResult`	`createKey(CreateKeyRequest createKeyRequest)` 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 createMapRequest)` 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 createPlaceIndexRequest)` Creates a place index resource in your Amazon Web Services account.
`CreateRouteCalculatorResult`	`createRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest)` Creates a route calculator resource in your Amazon Web Services account.
`CreateTrackerResult`	`createTracker(CreateTrackerRequest createTrackerRequest)` Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
`DeleteGeofenceCollectionResult`	`deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)` Deletes a geofence collection from your Amazon Web Services account.
`DeleteKeyResult`	`deleteKey(DeleteKeyRequest deleteKeyRequest)` Deletes the specified API key.
`DeleteMapResult`	`deleteMap(DeleteMapRequest deleteMapRequest)` Deletes a map resource from your Amazon Web Services account.
`DeletePlaceIndexResult`	`deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)` Deletes a place index resource from your Amazon Web Services account.
`DeleteRouteCalculatorResult`	`deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest)` Deletes a route calculator resource from your Amazon Web Services account.
`DeleteTrackerResult`	`deleteTracker(DeleteTrackerRequest deleteTrackerRequest)` Deletes a tracker resource from your Amazon Web Services account.
`DescribeGeofenceCollectionResult`	`describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)` Retrieves the geofence collection details.
`DescribeKeyResult`	`describeKey(DescribeKeyRequest describeKeyRequest)` Retrieves the API key resource details.
`DescribeMapResult`	`describeMap(DescribeMapRequest describeMapRequest)` Retrieves the map resource details.
`DescribePlaceIndexResult`	`describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)` Retrieves the place index resource details.
`DescribeRouteCalculatorResult`	`describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest)` Retrieves the route calculator resource details.
`DescribeTrackerResult`	`describeTracker(DescribeTrackerRequest describeTrackerRequest)` Retrieves the tracker resource details.
`DisassociateTrackerConsumerResult`	`disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)` Removes the association between a tracker resource and a geofence collection.
`ForecastGeofenceEventsResult`	`forecastGeofenceEvents(ForecastGeofenceEventsRequest forecastGeofenceEventsRequest)` 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 getDevicePositionRequest)` Retrieves a device's most recent position according to its sample time.
`GetDevicePositionHistoryResult`	`getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)` Retrieves the device position history from a tracker resource within a specified range of time.
`GetGeofenceResult`	`getGeofence(GetGeofenceRequest getGeofenceRequest)` Retrieves the geofence details from a geofence collection.
`GetMapGlyphsResult`	`getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)` Retrieves glyphs used to display labels on a map.
`GetMapSpritesResult`	`getMapSprites(GetMapSpritesRequest getMapSpritesRequest)` Retrieves the sprite sheet corresponding to a map resource.
`GetMapStyleDescriptorResult`	`getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)` Retrieves the map style descriptor from a map resource.
`GetMapTileResult`	`getMapTile(GetMapTileRequest getMapTileRequest)` Retrieves a vector data tile from the map resource.
`GetPlaceResult`	`getPlace(GetPlaceRequest getPlaceRequest)` Finds a place by its unique ID.
`ListDevicePositionsResult`	`listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)` A batch request to retrieve all device positions.
`ListGeofenceCollectionsResult`	`listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)` Lists geofence collections in your Amazon Web Services account.
`ListGeofencesResult`	`listGeofences(ListGeofencesRequest listGeofencesRequest)` Lists geofences stored in a given geofence collection.
`ListKeysResult`	`listKeys(ListKeysRequest listKeysRequest)` Lists API key resources in your Amazon Web Services account.
`ListMapsResult`	`listMaps(ListMapsRequest listMapsRequest)` Lists map resources in your Amazon Web Services account.
`ListPlaceIndexesResult`	`listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)` Lists place index resources in your Amazon Web Services account.
`ListRouteCalculatorsResult`	`listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest)` Lists route calculator resources in your Amazon Web Services account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of tags that are applied to the specified Amazon Location resource.
`ListTrackerConsumersResult`	`listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)` Lists geofence collections currently associated to the given tracker resource.
`ListTrackersResult`	`listTrackers(ListTrackersRequest listTrackersRequest)` Lists tracker resources in your Amazon Web Services account.
`PutGeofenceResult`	`putGeofence(PutGeofenceRequest putGeofenceRequest)` Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
`SearchPlaceIndexForPositionResult`	`searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)` Reverse geocodes a given coordinate and returns a legible address.
`SearchPlaceIndexForSuggestionsResult`	`searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest)` Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.
`SearchPlaceIndexForTextResult`	`searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)` Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags from the specified Amazon Location resource.
`UpdateGeofenceCollectionResult`	`updateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest)` Updates the specified properties of a given geofence collection.
`UpdateKeyResult`	`updateKey(UpdateKeyRequest updateKeyRequest)` Updates the specified properties of a given API key resource.
`UpdateMapResult`	`updateMap(UpdateMapRequest updateMapRequest)` Updates the specified properties of a given map resource.
`UpdatePlaceIndexResult`	`updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest)` Updates the specified properties of a given place index resource.
`UpdateRouteCalculatorResult`	`updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest)` Updates the specified properties for a given route calculator resource.
`UpdateTrackerResult`	`updateTracker(UpdateTrackerRequest updateTrackerRequest)` Updates the specified properties of a given tracker resource.
`VerifyDevicePositionResult`	`verifyDevicePosition(VerifyDevicePositionRequest verifyDevicePositionRequest)` 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.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - associateTrackerConsumer
```
AssociateTrackerConsumerResult associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)
```
    Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
    
    You can associate up to five geofence collections to each tracker resource.
    
    Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
    
    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
```
BatchDeleteDevicePositionHistoryResult batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest)
```
    Deletes the position history of one or more devices from a tracker resource.
    
    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
```
BatchDeleteGeofenceResult batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
```
    Deletes a batch of geofences from a geofence collection.
    
    This operation deletes the resource permanently.
    
    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
```
BatchEvaluateGeofencesResult batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
```
    Evaluates device positions against the geofence geometries from a given geofence collection.
    
    This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:
    - ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
    - EXIT if Amazon Location determines that the tracked device has exited a geofenced area.
    The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.
    
    Geofence evaluation uses the given device position. It does not account for the optional Accuracy of a DevicePositionUpdate.
    
    The DeviceID is used as a string to represent the device. You do not need to have a Tracker associated with the DeviceID.
    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
```
BatchGetDevicePositionResult batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
```
    Lists the latest device positions for requested devices.
    
    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
```
BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)
```
    A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
    
    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
```
BatchUpdateDevicePositionResult batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)
```
    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.
    
    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
```
CalculateRouteResult calculateRoute(CalculateRouteRequest calculateRouteRequest)
```
    Calculates a route given the following required parameters: DeparturePosition and DestinationPosition. Requires that you first create a route calculator resource.
    
    By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
    
    Additional options include:
    - Specifying a departure time using either DepartureTime or DepartNow. This calculates a route based on predictive traffic data at the given time.
      
      You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.
    - Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
      
      If you specify walking for the travel mode and your data provider is Esri, the start and destination must be within 40km.
    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
```
CalculateRouteMatrixResult calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)
```
    Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of DeparturePositions times the number of DestinationPositions.
    
    Your account is charged for each route calculated, not the number of requests.
    
    Requires that you first create a route calculator resource.
    
    By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.
    
    Additional options include:
    - Specifying a departure time using either DepartureTime or DepartNow. This calculates routes based on predictive traffic data at the given time.
      
      You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.
    - Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.
    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
```
CreateGeofenceCollectionResult createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)
```
    Creates a geofence collection, which manages and stores geofences.
    
    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
```
CreateKeyResult createKey(CreateKeyRequest createKeyRequest)
```
    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.
    
    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
```
CreateMapResult createMap(CreateMapRequest createMapRequest)
```
    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.
    
    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
```
CreatePlaceIndexResult createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
```
    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.
    
    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
```
CreateRouteCalculatorResult createRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest)
```
    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.
    
    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
```
CreateTrackerResult createTracker(CreateTrackerRequest createTrackerRequest)
```
    Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
    
    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
```
DeleteGeofenceCollectionResult deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)
```
    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.
    
    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
```
DeleteKeyResult deleteKey(DeleteKeyRequest deleteKeyRequest)
```
    Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
    
    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
```
DeleteMapResult deleteMap(DeleteMapRequest deleteMapRequest)
```
    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.
    
    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
```
DeletePlaceIndexResult deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
```
    Deletes a place index resource from your Amazon Web Services account.
    
    This operation deletes the resource permanently.
    
    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
```
DeleteRouteCalculatorResult deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest)
```
    Deletes a route calculator resource from your Amazon Web Services account.
    
    This operation deletes the resource permanently.
    
    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
```
DeleteTrackerResult deleteTracker(DeleteTrackerRequest deleteTrackerRequest)
```
    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.
    
    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
```
DescribeGeofenceCollectionResult describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)
```
    Retrieves the geofence collection details.
    
    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
```
DescribeKeyResult describeKey(DescribeKeyRequest describeKeyRequest)
```
    Retrieves the API key resource details.
    
    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
```
DescribeMapResult describeMap(DescribeMapRequest describeMapRequest)
```
    Retrieves the map resource details.
    
    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
```
DescribePlaceIndexResult describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
```
    Retrieves the place index resource details.
    
    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
```
DescribeRouteCalculatorResult describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest)
```
    Retrieves the route calculator resource details.
    
    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
```
DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrackerRequest)
```
    Retrieves the tracker resource details.
    
    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
```
DisassociateTrackerConsumerResult disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)
```
    Removes the association between a tracker resource and a geofence collection.
    
    Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
    
    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
```
ForecastGeofenceEventsResult forecastGeofenceEvents(ForecastGeofenceEventsRequest forecastGeofenceEventsRequest)
```
    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.
    
    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
```
GetDevicePositionResult getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
```
    Retrieves a device's most recent position according to its sample time.
    
    Device positions are deleted after 30 days.
    
    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
```
GetDevicePositionHistoryResult getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
```
    Retrieves the device position history from a tracker resource within a specified range of time.
    
    Device positions are deleted after 30 days.
    
    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
```
GetGeofenceResult getGeofence(GetGeofenceRequest getGeofenceRequest)
```
    Retrieves the geofence details from a geofence collection.
    
    The returned geometry will always match the geometry format used when the geofence was created.
    
    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
```
GetMapGlyphsResult getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)
```
    Retrieves glyphs used to display labels on a map.
    
    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
```
GetMapSpritesResult getMapSprites(GetMapSpritesRequest getMapSpritesRequest)
```
    Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
    
    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
```
GetMapStyleDescriptorResult getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)
```
    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.
    
    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
```
GetMapTileResult getMapTile(GetMapTileRequest getMapTileRequest)
```
    Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
    
    The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
    
    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
```
GetPlaceResult getPlace(GetPlaceRequest getPlaceRequest)
```
    Finds a place by its unique ID. A PlaceId is returned by other search operations.
    A PlaceId is valid only if all of the following are the same in the original search request and the call to GetPlace.
    
    Customer Amazon Web Services account
    
    Amazon Web Services Region
    
    Data provider specified in the place index resource
    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
```
ListDevicePositionsResult listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)
```
    A batch request to retrieve all device positions.
    
    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
```
ListGeofenceCollectionsResult listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
```
    Lists geofence collections in your Amazon Web Services account.
    
    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
```
ListGeofencesResult listGeofences(ListGeofencesRequest listGeofencesRequest)
```
    Lists geofences stored in a given geofence collection.
    
    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
```
ListKeysResult listKeys(ListKeysRequest listKeysRequest)
```
    Lists API key resources in your Amazon Web Services account.
    
    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
```
ListMapsResult listMaps(ListMapsRequest listMapsRequest)
```
    Lists map resources in your Amazon Web Services account.
    
    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
```
ListPlaceIndexesResult listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
```
    Lists place index resources in your Amazon Web Services account.
    
    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
```
ListRouteCalculatorsResult listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest)
```
    Lists route calculator resources in your Amazon Web Services account.
    
    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
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of tags that are applied to the specified Amazon Location resource.
    
    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
```
ListTrackerConsumersResult listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
```
    Lists geofence collections currently associated to the given tracker resource.
    
    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
```
ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest)
```
    Lists tracker resources in your Amazon Web Services account.
    
    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
```
PutGeofenceResult putGeofence(PutGeofenceRequest putGeofenceRequest)
```
    Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
    
    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
```
SearchPlaceIndexForPositionResult searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)
```
    Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
    
    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
```
SearchPlaceIndexForSuggestionsResult searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest)
```
    Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.
    
    Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
    
    You can search for suggested place names near a specified position by using BiasPosition, or filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error.
    
    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
```
SearchPlaceIndexForTextResult searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)
```
    Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
    
    Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
    
    You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
    
    Search results are returned in order of highest to lowest relevance.
    
    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
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    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
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes one or more tags from the specified Amazon Location resource.
    
    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
```
UpdateGeofenceCollectionResult updateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest)
```
    Updates the specified properties of a given geofence collection.
    
    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
```
UpdateKeyResult updateKey(UpdateKeyRequest updateKeyRequest)
```
    Updates the specified properties of a given API key resource.
    
    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
```
UpdateMapResult updateMap(UpdateMapRequest updateMapRequest)
```
    Updates the specified properties of a given map resource.
    
    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
```
UpdatePlaceIndexResult updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest)
```
    Updates the specified properties of a given place index resource.
    
    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
```
UpdateRouteCalculatorResult updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest)
```
    Updates the specified properties for a given route calculator resource.
    
    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
```
UpdateTrackerResult updateTracker(UpdateTrackerRequest updateTrackerRequest)
```
    Updates the specified properties of a given tracker resource.
    
    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
```
VerifyDevicePositionResult verifyDevicePosition(VerifyDevicePositionRequest verifyDevicePositionRequest)
```
    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.
    
    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
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AmazonLocation

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

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

shutdown

getCachedResponseMetadata