Interface LocationAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateTrackerConsumer
(Consumer<AssociateTrackerConsumerRequest.Builder> associateTrackerConsumerRequest) Creates an association between a geofence collection and a tracker resource.associateTrackerConsumer
(AssociateTrackerConsumerRequest associateTrackerConsumerRequest) Creates an association between a geofence collection and a tracker resource.batchDeleteDevicePositionHistory
(Consumer<BatchDeleteDevicePositionHistoryRequest.Builder> batchDeleteDevicePositionHistoryRequest) Deletes the position history of one or more devices from a tracker resource.batchDeleteDevicePositionHistory
(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest) Deletes the position history of one or more devices from a tracker resource.batchDeleteGeofence
(Consumer<BatchDeleteGeofenceRequest.Builder> batchDeleteGeofenceRequest) Deletes a batch of geofences from a geofence collection.batchDeleteGeofence
(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest) Deletes a batch of geofences from a geofence collection.batchEvaluateGeofences
(Consumer<BatchEvaluateGeofencesRequest.Builder> batchEvaluateGeofencesRequest) Evaluates device positions against the geofence geometries from a given geofence collection.batchEvaluateGeofences
(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest) Evaluates device positions against the geofence geometries from a given geofence collection.batchGetDevicePosition
(Consumer<BatchGetDevicePositionRequest.Builder> batchGetDevicePositionRequest) Lists the latest device positions for requested devices.batchGetDevicePosition
(BatchGetDevicePositionRequest batchGetDevicePositionRequest) Lists the latest device positions for requested devices.batchPutGeofence
(Consumer<BatchPutGeofenceRequest.Builder> 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.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.batchUpdateDevicePosition
(Consumer<BatchUpdateDevicePositionRequest.Builder> batchUpdateDevicePositionRequest) Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).batchUpdateDevicePosition
(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest) Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).static LocationAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aLocationAsyncClient
.default CompletableFuture
<CalculateRouteResponse> calculateRoute
(Consumer<CalculateRouteRequest.Builder> calculateRouteRequest) Calculates a route given the following required parameters:DeparturePosition
andDestinationPosition
.default CompletableFuture
<CalculateRouteResponse> calculateRoute
(CalculateRouteRequest calculateRouteRequest) Calculates a route given the following required parameters:DeparturePosition
andDestinationPosition
.calculateRouteMatrix
(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest) Calculates a route matrix given the following required parameters:DeparturePositions
andDestinationPositions
.calculateRouteMatrix
(CalculateRouteMatrixRequest calculateRouteMatrixRequest) Calculates a route matrix given the following required parameters:DeparturePositions
andDestinationPositions
.static LocationAsyncClient
create()
Create aLocationAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createGeofenceCollection
(Consumer<CreateGeofenceCollectionRequest.Builder> createGeofenceCollectionRequest) Creates a geofence collection, which manages and stores geofences.createGeofenceCollection
(CreateGeofenceCollectionRequest createGeofenceCollectionRequest) Creates a geofence collection, which manages and stores geofences.default CompletableFuture
<CreateKeyResponse> createKey
(Consumer<CreateKeyRequest.Builder> 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.default CompletableFuture
<CreateKeyResponse> 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.default CompletableFuture
<CreateMapResponse> createMap
(Consumer<CreateMapRequest.Builder> createMapRequest) Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.default CompletableFuture
<CreateMapResponse> 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.createPlaceIndex
(Consumer<CreatePlaceIndexRequest.Builder> createPlaceIndexRequest) Creates a place index resource in your Amazon Web Services account.createPlaceIndex
(CreatePlaceIndexRequest createPlaceIndexRequest) Creates a place index resource in your Amazon Web Services account.createRouteCalculator
(Consumer<CreateRouteCalculatorRequest.Builder> createRouteCalculatorRequest) Creates a route calculator resource in your Amazon Web Services account.createRouteCalculator
(CreateRouteCalculatorRequest createRouteCalculatorRequest) Creates a route calculator resource in your Amazon Web Services account.default CompletableFuture
<CreateTrackerResponse> createTracker
(Consumer<CreateTrackerRequest.Builder> createTrackerRequest) Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.default CompletableFuture
<CreateTrackerResponse> createTracker
(CreateTrackerRequest createTrackerRequest) Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.deleteGeofenceCollection
(Consumer<DeleteGeofenceCollectionRequest.Builder> deleteGeofenceCollectionRequest) Deletes a geofence collection from your Amazon Web Services account.deleteGeofenceCollection
(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest) Deletes a geofence collection from your Amazon Web Services account.default CompletableFuture
<DeleteKeyResponse> deleteKey
(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest) Deletes the specified API key.default CompletableFuture
<DeleteKeyResponse> deleteKey
(DeleteKeyRequest deleteKeyRequest) Deletes the specified API key.default CompletableFuture
<DeleteMapResponse> deleteMap
(Consumer<DeleteMapRequest.Builder> deleteMapRequest) Deletes a map resource from your Amazon Web Services account.default CompletableFuture
<DeleteMapResponse> deleteMap
(DeleteMapRequest deleteMapRequest) Deletes a map resource from your Amazon Web Services account.deletePlaceIndex
(Consumer<DeletePlaceIndexRequest.Builder> deletePlaceIndexRequest) Deletes a place index resource from your Amazon Web Services account.deletePlaceIndex
(DeletePlaceIndexRequest deletePlaceIndexRequest) Deletes a place index resource from your Amazon Web Services account.deleteRouteCalculator
(Consumer<DeleteRouteCalculatorRequest.Builder> deleteRouteCalculatorRequest) Deletes a route calculator resource from your Amazon Web Services account.deleteRouteCalculator
(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest) Deletes a route calculator resource from your Amazon Web Services account.default CompletableFuture
<DeleteTrackerResponse> deleteTracker
(Consumer<DeleteTrackerRequest.Builder> deleteTrackerRequest) Deletes a tracker resource from your Amazon Web Services account.default CompletableFuture
<DeleteTrackerResponse> deleteTracker
(DeleteTrackerRequest deleteTrackerRequest) Deletes a tracker resource from your Amazon Web Services account.describeGeofenceCollection
(Consumer<DescribeGeofenceCollectionRequest.Builder> describeGeofenceCollectionRequest) Retrieves the geofence collection details.describeGeofenceCollection
(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest) Retrieves the geofence collection details.default CompletableFuture
<DescribeKeyResponse> describeKey
(Consumer<DescribeKeyRequest.Builder> describeKeyRequest) Retrieves the API key resource details.default CompletableFuture
<DescribeKeyResponse> describeKey
(DescribeKeyRequest describeKeyRequest) Retrieves the API key resource details.default CompletableFuture
<DescribeMapResponse> describeMap
(Consumer<DescribeMapRequest.Builder> describeMapRequest) Retrieves the map resource details.default CompletableFuture
<DescribeMapResponse> describeMap
(DescribeMapRequest describeMapRequest) Retrieves the map resource details.describePlaceIndex
(Consumer<DescribePlaceIndexRequest.Builder> describePlaceIndexRequest) Retrieves the place index resource details.describePlaceIndex
(DescribePlaceIndexRequest describePlaceIndexRequest) Retrieves the place index resource details.describeRouteCalculator
(Consumer<DescribeRouteCalculatorRequest.Builder> describeRouteCalculatorRequest) Retrieves the route calculator resource details.describeRouteCalculator
(DescribeRouteCalculatorRequest describeRouteCalculatorRequest) Retrieves the route calculator resource details.default CompletableFuture
<DescribeTrackerResponse> describeTracker
(Consumer<DescribeTrackerRequest.Builder> describeTrackerRequest) Retrieves the tracker resource details.default CompletableFuture
<DescribeTrackerResponse> describeTracker
(DescribeTrackerRequest describeTrackerRequest) Retrieves the tracker resource details.disassociateTrackerConsumer
(Consumer<DisassociateTrackerConsumerRequest.Builder> disassociateTrackerConsumerRequest) Removes the association between a tracker resource and a geofence collection.disassociateTrackerConsumer
(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest) Removes the association between a tracker resource and a geofence collection.getDevicePosition
(Consumer<GetDevicePositionRequest.Builder> getDevicePositionRequest) Retrieves a device's most recent position according to its sample time.getDevicePosition
(GetDevicePositionRequest getDevicePositionRequest) Retrieves a device's most recent position according to its sample time.getDevicePositionHistory
(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest) Retrieves the device position history from a tracker resource within a specified range of time.getDevicePositionHistory
(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) Retrieves the device position history from a tracker resource within a specified range of time.getDevicePositionHistoryPaginator
(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest) This is a variant ofgetDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation.getDevicePositionHistoryPaginator
(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) This is a variant ofgetDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation.default CompletableFuture
<GetGeofenceResponse> getGeofence
(Consumer<GetGeofenceRequest.Builder> getGeofenceRequest) Retrieves the geofence details from a geofence collection.default CompletableFuture
<GetGeofenceResponse> getGeofence
(GetGeofenceRequest getGeofenceRequest) Retrieves the geofence details from a geofence collection.default CompletableFuture
<GetMapGlyphsResponse> getMapGlyphs
(Consumer<GetMapGlyphsRequest.Builder> getMapGlyphsRequest) Retrieves glyphs used to display labels on a map.default CompletableFuture
<GetMapGlyphsResponse> getMapGlyphs
(GetMapGlyphsRequest getMapGlyphsRequest) Retrieves glyphs used to display labels on a map.default CompletableFuture
<GetMapSpritesResponse> getMapSprites
(Consumer<GetMapSpritesRequest.Builder> getMapSpritesRequest) Retrieves the sprite sheet corresponding to a map resource.default CompletableFuture
<GetMapSpritesResponse> getMapSprites
(GetMapSpritesRequest getMapSpritesRequest) Retrieves the sprite sheet corresponding to a map resource.getMapStyleDescriptor
(Consumer<GetMapStyleDescriptorRequest.Builder> getMapStyleDescriptorRequest) Retrieves the map style descriptor from a map resource.getMapStyleDescriptor
(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest) Retrieves the map style descriptor from a map resource.default CompletableFuture
<GetMapTileResponse> getMapTile
(Consumer<GetMapTileRequest.Builder> getMapTileRequest) Retrieves a vector data tile from the map resource.default CompletableFuture
<GetMapTileResponse> getMapTile
(GetMapTileRequest getMapTileRequest) Retrieves a vector data tile from the map resource.default CompletableFuture
<GetPlaceResponse> getPlace
(Consumer<GetPlaceRequest.Builder> getPlaceRequest) Finds a place by its unique ID.default CompletableFuture
<GetPlaceResponse> getPlace
(GetPlaceRequest getPlaceRequest) Finds a place by its unique ID.listDevicePositions
(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest) A batch request to retrieve all device positions.listDevicePositions
(ListDevicePositionsRequest listDevicePositionsRequest) A batch request to retrieve all device positions.default ListDevicePositionsPublisher
listDevicePositionsPaginator
(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest) This is a variant oflistDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation.default ListDevicePositionsPublisher
listDevicePositionsPaginator
(ListDevicePositionsRequest listDevicePositionsRequest) This is a variant oflistDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation.listGeofenceCollections
(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest) Lists geofence collections in your Amazon Web Services account.listGeofenceCollections
(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) Lists geofence collections in your Amazon Web Services account.default ListGeofenceCollectionsPublisher
listGeofenceCollectionsPaginator
(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest) This is a variant oflistGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation.default ListGeofenceCollectionsPublisher
listGeofenceCollectionsPaginator
(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) This is a variant oflistGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation.default CompletableFuture
<ListGeofencesResponse> listGeofences
(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest) Lists geofences stored in a given geofence collection.default CompletableFuture
<ListGeofencesResponse> listGeofences
(ListGeofencesRequest listGeofencesRequest) Lists geofences stored in a given geofence collection.default ListGeofencesPublisher
listGeofencesPaginator
(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest) This is a variant oflistGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation.default ListGeofencesPublisher
listGeofencesPaginator
(ListGeofencesRequest listGeofencesRequest) This is a variant oflistGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation.default CompletableFuture
<ListKeysResponse> listKeys
(Consumer<ListKeysRequest.Builder> listKeysRequest) Lists API key resources in your Amazon Web Services account.default CompletableFuture
<ListKeysResponse> listKeys
(ListKeysRequest listKeysRequest) Lists API key resources in your Amazon Web Services account.default ListKeysPublisher
listKeysPaginator
(Consumer<ListKeysRequest.Builder> listKeysRequest) This is a variant oflistKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)
operation.default ListKeysPublisher
listKeysPaginator
(ListKeysRequest listKeysRequest) This is a variant oflistKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)
operation.default CompletableFuture
<ListMapsResponse> listMaps
(Consumer<ListMapsRequest.Builder> listMapsRequest) Lists map resources in your Amazon Web Services account.default CompletableFuture
<ListMapsResponse> listMaps
(ListMapsRequest listMapsRequest) Lists map resources in your Amazon Web Services account.default ListMapsPublisher
listMapsPaginator
(Consumer<ListMapsRequest.Builder> listMapsRequest) This is a variant oflistMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation.default ListMapsPublisher
listMapsPaginator
(ListMapsRequest listMapsRequest) This is a variant oflistMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation.listPlaceIndexes
(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest) Lists place index resources in your Amazon Web Services account.listPlaceIndexes
(ListPlaceIndexesRequest listPlaceIndexesRequest) Lists place index resources in your Amazon Web Services account.default ListPlaceIndexesPublisher
listPlaceIndexesPaginator
(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest) This is a variant oflistPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation.default ListPlaceIndexesPublisher
listPlaceIndexesPaginator
(ListPlaceIndexesRequest listPlaceIndexesRequest) This is a variant oflistPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation.listRouteCalculators
(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest) Lists route calculator resources in your Amazon Web Services account.listRouteCalculators
(ListRouteCalculatorsRequest listRouteCalculatorsRequest) Lists route calculator resources in your Amazon Web Services account.default ListRouteCalculatorsPublisher
listRouteCalculatorsPaginator
(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest) This is a variant oflistRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation.default ListRouteCalculatorsPublisher
listRouteCalculatorsPaginator
(ListRouteCalculatorsRequest listRouteCalculatorsRequest) This is a variant oflistRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Location resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Location resource.listTrackerConsumers
(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest) Lists geofence collections currently associated to the given tracker resource.listTrackerConsumers
(ListTrackerConsumersRequest listTrackerConsumersRequest) Lists geofence collections currently associated to the given tracker resource.default ListTrackerConsumersPublisher
listTrackerConsumersPaginator
(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest) This is a variant oflistTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation.default ListTrackerConsumersPublisher
listTrackerConsumersPaginator
(ListTrackerConsumersRequest listTrackerConsumersRequest) This is a variant oflistTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation.default CompletableFuture
<ListTrackersResponse> listTrackers
(Consumer<ListTrackersRequest.Builder> listTrackersRequest) Lists tracker resources in your Amazon Web Services account.default CompletableFuture
<ListTrackersResponse> listTrackers
(ListTrackersRequest listTrackersRequest) Lists tracker resources in your Amazon Web Services account.default ListTrackersPublisher
listTrackersPaginator
(Consumer<ListTrackersRequest.Builder> listTrackersRequest) This is a variant oflistTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation.default ListTrackersPublisher
listTrackersPaginator
(ListTrackersRequest listTrackersRequest) This is a variant oflistTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation.default CompletableFuture
<PutGeofenceResponse> putGeofence
(Consumer<PutGeofenceRequest.Builder> 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.default CompletableFuture
<PutGeofenceResponse> 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.searchPlaceIndexForPosition
(Consumer<SearchPlaceIndexForPositionRequest.Builder> searchPlaceIndexForPositionRequest) Reverse geocodes a given coordinate and returns a legible address.searchPlaceIndexForPosition
(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest) Reverse geocodes a given coordinate and returns a legible address.searchPlaceIndexForSuggestions
(Consumer<SearchPlaceIndexForSuggestionsRequest.Builder> searchPlaceIndexForSuggestionsRequest) Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.searchPlaceIndexForSuggestions
(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest) Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.searchPlaceIndexForText
(Consumer<SearchPlaceIndexForTextRequest.Builder> searchPlaceIndexForTextRequest) Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified Amazon Location resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified Amazon Location resource.updateGeofenceCollection
(Consumer<UpdateGeofenceCollectionRequest.Builder> updateGeofenceCollectionRequest) Updates the specified properties of a given geofence collection.updateGeofenceCollection
(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest) Updates the specified properties of a given geofence collection.default CompletableFuture
<UpdateKeyResponse> updateKey
(Consumer<UpdateKeyRequest.Builder> updateKeyRequest) Updates the specified properties of a given API key resource.default CompletableFuture
<UpdateKeyResponse> updateKey
(UpdateKeyRequest updateKeyRequest) Updates the specified properties of a given API key resource.default CompletableFuture
<UpdateMapResponse> updateMap
(Consumer<UpdateMapRequest.Builder> updateMapRequest) Updates the specified properties of a given map resource.default CompletableFuture
<UpdateMapResponse> updateMap
(UpdateMapRequest updateMapRequest) Updates the specified properties of a given map resource.updatePlaceIndex
(Consumer<UpdatePlaceIndexRequest.Builder> updatePlaceIndexRequest) Updates the specified properties of a given place index resource.updatePlaceIndex
(UpdatePlaceIndexRequest updatePlaceIndexRequest) Updates the specified properties of a given place index resource.updateRouteCalculator
(Consumer<UpdateRouteCalculatorRequest.Builder> updateRouteCalculatorRequest) Updates the specified properties for a given route calculator resource.updateRouteCalculator
(UpdateRouteCalculatorRequest updateRouteCalculatorRequest) Updates the specified properties for a given route calculator resource.default CompletableFuture
<UpdateTrackerResponse> updateTracker
(Consumer<UpdateTrackerRequest.Builder> updateTrackerRequest) Updates the specified properties of a given tracker resource.default CompletableFuture
<UpdateTrackerResponse> updateTracker
(UpdateTrackerRequest updateTrackerRequest) Updates the specified properties of a given tracker resource.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateTrackerConsumer
default CompletableFuture<AssociateTrackerConsumerResponse> 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:
- A Java Future containing the result of the AssociateTrackerConsumer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateTrackerConsumer
default CompletableFuture<AssociateTrackerConsumerResponse> associateTrackerConsumer(Consumer<AssociateTrackerConsumerRequest.Builder> 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.
This is a convenience which creates an instance of the
AssociateTrackerConsumerRequest.Builder
avoiding the need to create one manually viaAssociateTrackerConsumerRequest.builder()
- Parameters:
associateTrackerConsumerRequest
- AConsumer
that will call methods onAssociateTrackerConsumerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateTrackerConsumer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteDevicePositionHistory
default CompletableFuture<BatchDeleteDevicePositionHistoryResponse> batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest) Deletes the position history of one or more devices from a tracker resource.
- Parameters:
batchDeleteDevicePositionHistoryRequest
-- Returns:
- A Java Future containing the result of the BatchDeleteDevicePositionHistory operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteDevicePositionHistory
default CompletableFuture<BatchDeleteDevicePositionHistoryResponse> batchDeleteDevicePositionHistory(Consumer<BatchDeleteDevicePositionHistoryRequest.Builder> batchDeleteDevicePositionHistoryRequest) Deletes the position history of one or more devices from a tracker resource.
This is a convenience which creates an instance of the
BatchDeleteDevicePositionHistoryRequest.Builder
avoiding the need to create one manually viaBatchDeleteDevicePositionHistoryRequest.builder()
- Parameters:
batchDeleteDevicePositionHistoryRequest
- AConsumer
that will call methods onBatchDeleteDevicePositionHistoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDeleteDevicePositionHistory operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteGeofence
default CompletableFuture<BatchDeleteGeofenceResponse> batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest) Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
- Parameters:
batchDeleteGeofenceRequest
-- Returns:
- A Java Future containing the result of the BatchDeleteGeofence operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteGeofence
default CompletableFuture<BatchDeleteGeofenceResponse> batchDeleteGeofence(Consumer<BatchDeleteGeofenceRequest.Builder> batchDeleteGeofenceRequest) Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
This is a convenience which creates an instance of the
BatchDeleteGeofenceRequest.Builder
avoiding the need to create one manually viaBatchDeleteGeofenceRequest.builder()
- Parameters:
batchDeleteGeofenceRequest
- AConsumer
that will call methods onBatchDeleteGeofenceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDeleteGeofence operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchEvaluateGeofences
default CompletableFuture<BatchEvaluateGeofencesResponse> 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 aDevicePositionUpdate
.The
DeviceID
is used as a string to represent the device. You do not need to have aTracker
associated with theDeviceID
.- Parameters:
batchEvaluateGeofencesRequest
-- Returns:
- A Java Future containing the result of the BatchEvaluateGeofences operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchEvaluateGeofences
default CompletableFuture<BatchEvaluateGeofencesResponse> batchEvaluateGeofences(Consumer<BatchEvaluateGeofencesRequest.Builder> 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 aDevicePositionUpdate
.The
DeviceID
is used as a string to represent the device. You do not need to have aTracker
associated with theDeviceID
.
This is a convenience which creates an instance of the
BatchEvaluateGeofencesRequest.Builder
avoiding the need to create one manually viaBatchEvaluateGeofencesRequest.builder()
- Parameters:
batchEvaluateGeofencesRequest
- AConsumer
that will call methods onBatchEvaluateGeofencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchEvaluateGeofences operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchGetDevicePosition
default CompletableFuture<BatchGetDevicePositionResponse> batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest) Lists the latest device positions for requested devices.
- Parameters:
batchGetDevicePositionRequest
-- Returns:
- A Java Future containing the result of the BatchGetDevicePosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetDevicePosition
default CompletableFuture<BatchGetDevicePositionResponse> batchGetDevicePosition(Consumer<BatchGetDevicePositionRequest.Builder> batchGetDevicePositionRequest) Lists the latest device positions for requested devices.
This is a convenience which creates an instance of the
BatchGetDevicePositionRequest.Builder
avoiding the need to create one manually viaBatchGetDevicePositionRequest.builder()
- Parameters:
batchGetDevicePositionRequest
- AConsumer
that will call methods onBatchGetDevicePositionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetDevicePosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchPutGeofence
default CompletableFuture<BatchPutGeofenceResponse> 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:
- A Java Future containing the result of the BatchPutGeofence operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchPutGeofence
default CompletableFuture<BatchPutGeofenceResponse> batchPutGeofence(Consumer<BatchPutGeofenceRequest.Builder> 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.
This is a convenience which creates an instance of the
BatchPutGeofenceRequest.Builder
avoiding the need to create one manually viaBatchPutGeofenceRequest.builder()
- Parameters:
batchPutGeofenceRequest
- AConsumer
that will call methods onBatchPutGeofenceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchPutGeofence operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateDevicePosition
default CompletableFuture<BatchUpdateDevicePositionResponse> 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. WhenPositionFiltering
is set toTimeBased
, 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 toDistanceBased
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 toAccuracyBased
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. IfPositionFiltering
is set toAccuracyBased
filtering, Amazon Location uses the default value{ "Horizontal": 0}
when accuracy is not provided on aDevicePositionUpdate
.- Parameters:
batchUpdateDevicePositionRequest
-- Returns:
- A Java Future containing the result of the BatchUpdateDevicePosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateDevicePosition
default CompletableFuture<BatchUpdateDevicePositionResponse> batchUpdateDevicePosition(Consumer<BatchUpdateDevicePositionRequest.Builder> 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. WhenPositionFiltering
is set toTimeBased
, 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 toDistanceBased
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 toAccuracyBased
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. IfPositionFiltering
is set toAccuracyBased
filtering, Amazon Location uses the default value{ "Horizontal": 0}
when accuracy is not provided on aDevicePositionUpdate
.
This is a convenience which creates an instance of the
BatchUpdateDevicePositionRequest.Builder
avoiding the need to create one manually viaBatchUpdateDevicePositionRequest.builder()
- Parameters:
batchUpdateDevicePositionRequest
- AConsumer
that will call methods onBatchUpdateDevicePositionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchUpdateDevicePosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
calculateRoute
default CompletableFuture<CalculateRouteResponse> calculateRoute(CalculateRouteRequest calculateRouteRequest) Calculates a route given the following required parameters:
DeparturePosition
andDestinationPosition
. 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
orDepartNow
. This calculates a route based on predictive traffic data at the given time.You can't specify both
DepartureTime
andDepartNow
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 byCar
, orTruckModeOptions
if traveling byTruck
.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:
- A Java Future containing the result of the CalculateRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
calculateRoute
default CompletableFuture<CalculateRouteResponse> calculateRoute(Consumer<CalculateRouteRequest.Builder> calculateRouteRequest) Calculates a route given the following required parameters:
DeparturePosition
andDestinationPosition
. 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
orDepartNow
. This calculates a route based on predictive traffic data at the given time.You can't specify both
DepartureTime
andDepartNow
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 byCar
, orTruckModeOptions
if traveling byTruck
.If you specify
walking
for the travel mode and your data provider is Esri, the start and destination must be within 40km.
This is a convenience which creates an instance of the
CalculateRouteRequest.Builder
avoiding the need to create one manually viaCalculateRouteRequest.builder()
- Parameters:
calculateRouteRequest
- AConsumer
that will call methods onCalculateRouteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CalculateRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
calculateRouteMatrix
default CompletableFuture<CalculateRouteMatrixResponse> calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest) Calculates a route matrix given the following required parameters:
DeparturePositions
andDestinationPositions
.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 ofDeparturePositions
times the number ofDestinationPositions
.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
orDepartNow
. This calculates routes based on predictive traffic data at the given time.You can't specify both
DepartureTime
andDepartNow
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 byCar
, orTruckModeOptions
if traveling byTruck
.
- Parameters:
calculateRouteMatrixRequest
-- Returns:
- A Java Future containing the result of the CalculateRouteMatrix operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
calculateRouteMatrix
default CompletableFuture<CalculateRouteMatrixResponse> calculateRouteMatrix(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest) Calculates a route matrix given the following required parameters:
DeparturePositions
andDestinationPositions
.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 ofDeparturePositions
times the number ofDestinationPositions
.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
orDepartNow
. This calculates routes based on predictive traffic data at the given time.You can't specify both
DepartureTime
andDepartNow
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 byCar
, orTruckModeOptions
if traveling byTruck
.
This is a convenience which creates an instance of the
CalculateRouteMatrixRequest.Builder
avoiding the need to create one manually viaCalculateRouteMatrixRequest.builder()
- Parameters:
calculateRouteMatrixRequest
- AConsumer
that will call methods onCalculateRouteMatrixRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CalculateRouteMatrix operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createGeofenceCollection
default CompletableFuture<CreateGeofenceCollectionResponse> createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest) Creates a geofence collection, which manages and stores geofences.
- Parameters:
createGeofenceCollectionRequest
-- Returns:
- A Java Future containing the result of the CreateGeofenceCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGeofenceCollection
default CompletableFuture<CreateGeofenceCollectionResponse> createGeofenceCollection(Consumer<CreateGeofenceCollectionRequest.Builder> createGeofenceCollectionRequest) Creates a geofence collection, which manages and stores geofences.
This is a convenience which creates an instance of the
CreateGeofenceCollectionRequest.Builder
avoiding the need to create one manually viaCreateGeofenceCollectionRequest.builder()
- Parameters:
createGeofenceCollectionRequest
- AConsumer
that will call methods onCreateGeofenceCollectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGeofenceCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKey
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:
- A Java Future containing the result of the CreateKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKey
default CompletableFuture<CreateKeyResponse> createKey(Consumer<CreateKeyRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateKeyRequest.Builder
avoiding the need to create one manually viaCreateKeyRequest.builder()
- Parameters:
createKeyRequest
- AConsumer
that will call methods onCreateKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMap
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:
- A Java Future containing the result of the CreateMap operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMap
default CompletableFuture<CreateMapResponse> createMap(Consumer<CreateMapRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateMapRequest.Builder
avoiding the need to create one manually viaCreateMapRequest.builder()
- Parameters:
createMapRequest
- AConsumer
that will call methods onCreateMapRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMap operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlaceIndex
default CompletableFuture<CreatePlaceIndexResponse> 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 theSearchPlaceIndexForPosition
operation, and enable autosuggestions by using theSearchPlaceIndexForSuggestions
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:
- A Java Future containing the result of the CreatePlaceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlaceIndex
default CompletableFuture<CreatePlaceIndexResponse> createPlaceIndex(Consumer<CreatePlaceIndexRequest.Builder> 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 theSearchPlaceIndexForPosition
operation, and enable autosuggestions by using theSearchPlaceIndexForSuggestions
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.
This is a convenience which creates an instance of the
CreatePlaceIndexRequest.Builder
avoiding the need to create one manually viaCreatePlaceIndexRequest.builder()
- Parameters:
createPlaceIndexRequest
- AConsumer
that will call methods onCreatePlaceIndexRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePlaceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRouteCalculator
default CompletableFuture<CreateRouteCalculatorResponse> 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:
- A Java Future containing the result of the CreateRouteCalculator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRouteCalculator
default CompletableFuture<CreateRouteCalculatorResponse> createRouteCalculator(Consumer<CreateRouteCalculatorRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateRouteCalculatorRequest.Builder
avoiding the need to create one manually viaCreateRouteCalculatorRequest.builder()
- Parameters:
createRouteCalculatorRequest
- AConsumer
that will call methods onCreateRouteCalculatorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRouteCalculator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTracker
default CompletableFuture<CreateTrackerResponse> 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:
- A Java Future containing the result of the CreateTracker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTracker
default CompletableFuture<CreateTrackerResponse> createTracker(Consumer<CreateTrackerRequest.Builder> createTrackerRequest) Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
This is a convenience which creates an instance of the
CreateTrackerRequest.Builder
avoiding the need to create one manually viaCreateTrackerRequest.builder()
- Parameters:
createTrackerRequest
- AConsumer
that will call methods onCreateTrackerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTracker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGeofenceCollection
default CompletableFuture<DeleteGeofenceCollectionResponse> 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:
- A Java Future containing the result of the DeleteGeofenceCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGeofenceCollection
default CompletableFuture<DeleteGeofenceCollectionResponse> deleteGeofenceCollection(Consumer<DeleteGeofenceCollectionRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteGeofenceCollectionRequest.Builder
avoiding the need to create one manually viaDeleteGeofenceCollectionRequest.builder()
- Parameters:
deleteGeofenceCollectionRequest
- AConsumer
that will call methods onDeleteGeofenceCollectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGeofenceCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKey
Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
- Parameters:
deleteKeyRequest
-- Returns:
- A Java Future containing the result of the DeleteKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKey
default CompletableFuture<DeleteKeyResponse> deleteKey(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest) Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
This is a convenience which creates an instance of the
DeleteKeyRequest.Builder
avoiding the need to create one manually viaDeleteKeyRequest.builder()
- Parameters:
deleteKeyRequest
- AConsumer
that will call methods onDeleteKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMap
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:
- A Java Future containing the result of the DeleteMap operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMap
default CompletableFuture<DeleteMapResponse> deleteMap(Consumer<DeleteMapRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteMapRequest.Builder
avoiding the need to create one manually viaDeleteMapRequest.builder()
- Parameters:
deleteMapRequest
- AConsumer
that will call methods onDeleteMapRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMap operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePlaceIndex
default CompletableFuture<DeletePlaceIndexResponse> deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest) Deletes a place index resource from your Amazon Web Services account.
This operation deletes the resource permanently.
- Parameters:
deletePlaceIndexRequest
-- Returns:
- A Java Future containing the result of the DeletePlaceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePlaceIndex
default CompletableFuture<DeletePlaceIndexResponse> deletePlaceIndex(Consumer<DeletePlaceIndexRequest.Builder> deletePlaceIndexRequest) Deletes a place index resource from your Amazon Web Services account.
This operation deletes the resource permanently.
This is a convenience which creates an instance of the
DeletePlaceIndexRequest.Builder
avoiding the need to create one manually viaDeletePlaceIndexRequest.builder()
- Parameters:
deletePlaceIndexRequest
- AConsumer
that will call methods onDeletePlaceIndexRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePlaceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRouteCalculator
default CompletableFuture<DeleteRouteCalculatorResponse> deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest) Deletes a route calculator resource from your Amazon Web Services account.
This operation deletes the resource permanently.
- Parameters:
deleteRouteCalculatorRequest
-- Returns:
- A Java Future containing the result of the DeleteRouteCalculator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRouteCalculator
default CompletableFuture<DeleteRouteCalculatorResponse> deleteRouteCalculator(Consumer<DeleteRouteCalculatorRequest.Builder> deleteRouteCalculatorRequest) Deletes a route calculator resource from your Amazon Web Services account.
This operation deletes the resource permanently.
This is a convenience which creates an instance of the
DeleteRouteCalculatorRequest.Builder
avoiding the need to create one manually viaDeleteRouteCalculatorRequest.builder()
- Parameters:
deleteRouteCalculatorRequest
- AConsumer
that will call methods onDeleteRouteCalculatorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRouteCalculator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTracker
default CompletableFuture<DeleteTrackerResponse> 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:
- A Java Future containing the result of the DeleteTracker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTracker
default CompletableFuture<DeleteTrackerResponse> deleteTracker(Consumer<DeleteTrackerRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteTrackerRequest.Builder
avoiding the need to create one manually viaDeleteTrackerRequest.builder()
- Parameters:
deleteTrackerRequest
- AConsumer
that will call methods onDeleteTrackerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTracker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGeofenceCollection
default CompletableFuture<DescribeGeofenceCollectionResponse> describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest) Retrieves the geofence collection details.
- Parameters:
describeGeofenceCollectionRequest
-- Returns:
- A Java Future containing the result of the DescribeGeofenceCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGeofenceCollection
default CompletableFuture<DescribeGeofenceCollectionResponse> describeGeofenceCollection(Consumer<DescribeGeofenceCollectionRequest.Builder> describeGeofenceCollectionRequest) Retrieves the geofence collection details.
This is a convenience which creates an instance of the
DescribeGeofenceCollectionRequest.Builder
avoiding the need to create one manually viaDescribeGeofenceCollectionRequest.builder()
- Parameters:
describeGeofenceCollectionRequest
- AConsumer
that will call methods onDescribeGeofenceCollectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGeofenceCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeKey
Retrieves the API key resource details.
- Parameters:
describeKeyRequest
-- Returns:
- A Java Future containing the result of the DescribeKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeKey
default CompletableFuture<DescribeKeyResponse> describeKey(Consumer<DescribeKeyRequest.Builder> describeKeyRequest) Retrieves the API key resource details.
This is a convenience which creates an instance of the
DescribeKeyRequest.Builder
avoiding the need to create one manually viaDescribeKeyRequest.builder()
- Parameters:
describeKeyRequest
- AConsumer
that will call methods onDescribeKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMap
Retrieves the map resource details.
- Parameters:
describeMapRequest
-- Returns:
- A Java Future containing the result of the DescribeMap operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMap
default CompletableFuture<DescribeMapResponse> describeMap(Consumer<DescribeMapRequest.Builder> describeMapRequest) Retrieves the map resource details.
This is a convenience which creates an instance of the
DescribeMapRequest.Builder
avoiding the need to create one manually viaDescribeMapRequest.builder()
- Parameters:
describeMapRequest
- AConsumer
that will call methods onDescribeMapRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeMap operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePlaceIndex
default CompletableFuture<DescribePlaceIndexResponse> describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest) Retrieves the place index resource details.
- Parameters:
describePlaceIndexRequest
-- Returns:
- A Java Future containing the result of the DescribePlaceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePlaceIndex
default CompletableFuture<DescribePlaceIndexResponse> describePlaceIndex(Consumer<DescribePlaceIndexRequest.Builder> describePlaceIndexRequest) Retrieves the place index resource details.
This is a convenience which creates an instance of the
DescribePlaceIndexRequest.Builder
avoiding the need to create one manually viaDescribePlaceIndexRequest.builder()
- Parameters:
describePlaceIndexRequest
- AConsumer
that will call methods onDescribePlaceIndexRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePlaceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRouteCalculator
default CompletableFuture<DescribeRouteCalculatorResponse> describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest) Retrieves the route calculator resource details.
- Parameters:
describeRouteCalculatorRequest
-- Returns:
- A Java Future containing the result of the DescribeRouteCalculator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRouteCalculator
default CompletableFuture<DescribeRouteCalculatorResponse> describeRouteCalculator(Consumer<DescribeRouteCalculatorRequest.Builder> describeRouteCalculatorRequest) Retrieves the route calculator resource details.
This is a convenience which creates an instance of the
DescribeRouteCalculatorRequest.Builder
avoiding the need to create one manually viaDescribeRouteCalculatorRequest.builder()
- Parameters:
describeRouteCalculatorRequest
- AConsumer
that will call methods onDescribeRouteCalculatorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRouteCalculator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTracker
default CompletableFuture<DescribeTrackerResponse> describeTracker(DescribeTrackerRequest describeTrackerRequest) Retrieves the tracker resource details.
- Parameters:
describeTrackerRequest
-- Returns:
- A Java Future containing the result of the DescribeTracker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTracker
default CompletableFuture<DescribeTrackerResponse> describeTracker(Consumer<DescribeTrackerRequest.Builder> describeTrackerRequest) Retrieves the tracker resource details.
This is a convenience which creates an instance of the
DescribeTrackerRequest.Builder
avoiding the need to create one manually viaDescribeTrackerRequest.builder()
- Parameters:
describeTrackerRequest
- AConsumer
that will call methods onDescribeTrackerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTracker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateTrackerConsumer
default CompletableFuture<DisassociateTrackerConsumerResponse> 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:
- A Java Future containing the result of the DisassociateTrackerConsumer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateTrackerConsumer
default CompletableFuture<DisassociateTrackerConsumerResponse> disassociateTrackerConsumer(Consumer<DisassociateTrackerConsumerRequest.Builder> 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.
This is a convenience which creates an instance of the
DisassociateTrackerConsumerRequest.Builder
avoiding the need to create one manually viaDisassociateTrackerConsumerRequest.builder()
- Parameters:
disassociateTrackerConsumerRequest
- AConsumer
that will call methods onDisassociateTrackerConsumerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateTrackerConsumer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevicePosition
default CompletableFuture<GetDevicePositionResponse> 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:
- A Java Future containing the result of the GetDevicePosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevicePosition
default CompletableFuture<GetDevicePositionResponse> getDevicePosition(Consumer<GetDevicePositionRequest.Builder> getDevicePositionRequest) Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
This is a convenience which creates an instance of the
GetDevicePositionRequest.Builder
avoiding the need to create one manually viaGetDevicePositionRequest.builder()
- Parameters:
getDevicePositionRequest
- AConsumer
that will call methods onGetDevicePositionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDevicePosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevicePositionHistory
default CompletableFuture<GetDevicePositionHistoryResponse> 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:
- A Java Future containing the result of the GetDevicePositionHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevicePositionHistory
default CompletableFuture<GetDevicePositionHistoryResponse> getDevicePositionHistory(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest) Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
This is a convenience which creates an instance of the
GetDevicePositionHistoryRequest.Builder
avoiding the need to create one manually viaGetDevicePositionHistoryRequest.builder()
- Parameters:
getDevicePositionHistoryRequest
- AConsumer
that will call methods onGetDevicePositionHistoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDevicePositionHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevicePositionHistoryPaginator
default GetDevicePositionHistoryPublisher getDevicePositionHistoryPaginator(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) This is a variant of
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryPublisher publisher = client.getDevicePositionHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryPublisher publisher = client.getDevicePositionHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation.- Parameters:
getDevicePositionHistoryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevicePositionHistoryPaginator
default GetDevicePositionHistoryPublisher getDevicePositionHistoryPaginator(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest) This is a variant of
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryPublisher publisher = client.getDevicePositionHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryPublisher publisher = client.getDevicePositionHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation.
This is a convenience which creates an instance of the
GetDevicePositionHistoryRequest.Builder
avoiding the need to create one manually viaGetDevicePositionHistoryRequest.builder()
- Parameters:
getDevicePositionHistoryRequest
- AConsumer
that will call methods onGetDevicePositionHistoryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGeofence
Retrieves the geofence details from a geofence collection.
- Parameters:
getGeofenceRequest
-- Returns:
- A Java Future containing the result of the GetGeofence operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGeofence
default CompletableFuture<GetGeofenceResponse> getGeofence(Consumer<GetGeofenceRequest.Builder> getGeofenceRequest) Retrieves the geofence details from a geofence collection.
This is a convenience which creates an instance of the
GetGeofenceRequest.Builder
avoiding the need to create one manually viaGetGeofenceRequest.builder()
- Parameters:
getGeofenceRequest
- AConsumer
that will call methods onGetGeofenceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGeofence operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMapGlyphs
default CompletableFuture<GetMapGlyphsResponse> getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest) Retrieves glyphs used to display labels on a map.
- Parameters:
getMapGlyphsRequest
-- Returns:
- A Java Future containing the result of the GetMapGlyphs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMapGlyphs
default CompletableFuture<GetMapGlyphsResponse> getMapGlyphs(Consumer<GetMapGlyphsRequest.Builder> getMapGlyphsRequest) Retrieves glyphs used to display labels on a map.
This is a convenience which creates an instance of the
GetMapGlyphsRequest.Builder
avoiding the need to create one manually viaGetMapGlyphsRequest.builder()
- Parameters:
getMapGlyphsRequest
- AConsumer
that will call methods onGetMapGlyphsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMapGlyphs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMapSprites
default CompletableFuture<GetMapSpritesResponse> 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:
- A Java Future containing the result of the GetMapSprites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMapSprites
default CompletableFuture<GetMapSpritesResponse> getMapSprites(Consumer<GetMapSpritesRequest.Builder> 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.
This is a convenience which creates an instance of the
GetMapSpritesRequest.Builder
avoiding the need to create one manually viaGetMapSpritesRequest.builder()
- Parameters:
getMapSpritesRequest
- AConsumer
that will call methods onGetMapSpritesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMapSprites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMapStyleDescriptor
default CompletableFuture<GetMapStyleDescriptorResponse> getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest) Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
- Parameters:
getMapStyleDescriptorRequest
-- Returns:
- A Java Future containing the result of the GetMapStyleDescriptor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMapStyleDescriptor
default CompletableFuture<GetMapStyleDescriptorResponse> getMapStyleDescriptor(Consumer<GetMapStyleDescriptorRequest.Builder> getMapStyleDescriptorRequest) Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
This is a convenience which creates an instance of the
GetMapStyleDescriptorRequest.Builder
avoiding the need to create one manually viaGetMapStyleDescriptorRequest.builder()
- Parameters:
getMapStyleDescriptorRequest
- AConsumer
that will call methods onGetMapStyleDescriptorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMapStyleDescriptor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMapTile
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:
- A Java Future containing the result of the GetMapTile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMapTile
default CompletableFuture<GetMapTileResponse> getMapTile(Consumer<GetMapTileRequest.Builder> 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).
This is a convenience which creates an instance of the
GetMapTileRequest.Builder
avoiding the need to create one manually viaGetMapTileRequest.builder()
- Parameters:
getMapTileRequest
- AConsumer
that will call methods onGetMapTileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMapTile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPlace
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:
- A Java Future containing the result of the GetPlace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getPlace
default CompletableFuture<GetPlaceResponse> getPlace(Consumer<GetPlaceRequest.Builder> 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
This is a convenience which creates an instance of the
GetPlaceRequest.Builder
avoiding the need to create one manually viaGetPlaceRequest.builder()
- Parameters:
getPlaceRequest
- AConsumer
that will call methods onGetPlaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPlace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listDevicePositions
default CompletableFuture<ListDevicePositionsResponse> listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest) A batch request to retrieve all device positions.
- Parameters:
listDevicePositionsRequest
-- Returns:
- A Java Future containing the result of the ListDevicePositions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicePositions
default CompletableFuture<ListDevicePositionsResponse> listDevicePositions(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest) A batch request to retrieve all device positions.
This is a convenience which creates an instance of the
ListDevicePositionsRequest.Builder
avoiding the need to create one manually viaListDevicePositionsRequest.builder()
- Parameters:
listDevicePositionsRequest
- AConsumer
that will call methods onListDevicePositionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDevicePositions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicePositionsPaginator
default ListDevicePositionsPublisher listDevicePositionsPaginator(ListDevicePositionsRequest listDevicePositionsRequest) This is a variant of
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListDevicePositionsPublisher publisher = client.listDevicePositionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListDevicePositionsPublisher publisher = client.listDevicePositionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListDevicePositionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListDevicePositionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation.- Parameters:
listDevicePositionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicePositionsPaginator
default ListDevicePositionsPublisher listDevicePositionsPaginator(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest) This is a variant of
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListDevicePositionsPublisher publisher = client.listDevicePositionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListDevicePositionsPublisher publisher = client.listDevicePositionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListDevicePositionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListDevicePositionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation.
This is a convenience which creates an instance of the
ListDevicePositionsRequest.Builder
avoiding the need to create one manually viaListDevicePositionsRequest.builder()
- Parameters:
listDevicePositionsRequest
- AConsumer
that will call methods onListDevicePositionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeofenceCollections
default CompletableFuture<ListGeofenceCollectionsResponse> listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) Lists geofence collections in your Amazon Web Services account.
- Parameters:
listGeofenceCollectionsRequest
-- Returns:
- A Java Future containing the result of the ListGeofenceCollections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeofenceCollections
default CompletableFuture<ListGeofenceCollectionsResponse> listGeofenceCollections(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest) Lists geofence collections in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListGeofenceCollectionsRequest.Builder
avoiding the need to create one manually viaListGeofenceCollectionsRequest.builder()
- Parameters:
listGeofenceCollectionsRequest
- AConsumer
that will call methods onListGeofenceCollectionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGeofenceCollections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeofenceCollectionsPaginator
default ListGeofenceCollectionsPublisher listGeofenceCollectionsPaginator(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) This is a variant of
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsPublisher publisher = client.listGeofenceCollectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsPublisher publisher = client.listGeofenceCollectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation.- Parameters:
listGeofenceCollectionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeofenceCollectionsPaginator
default ListGeofenceCollectionsPublisher listGeofenceCollectionsPaginator(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest) This is a variant of
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsPublisher publisher = client.listGeofenceCollectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsPublisher publisher = client.listGeofenceCollectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation.
This is a convenience which creates an instance of the
ListGeofenceCollectionsRequest.Builder
avoiding the need to create one manually viaListGeofenceCollectionsRequest.builder()
- Parameters:
listGeofenceCollectionsRequest
- AConsumer
that will call methods onListGeofenceCollectionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeofences
default CompletableFuture<ListGeofencesResponse> listGeofences(ListGeofencesRequest listGeofencesRequest) Lists geofences stored in a given geofence collection.
- Parameters:
listGeofencesRequest
-- Returns:
- A Java Future containing the result of the ListGeofences operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeofences
default CompletableFuture<ListGeofencesResponse> listGeofences(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest) Lists geofences stored in a given geofence collection.
This is a convenience which creates an instance of the
ListGeofencesRequest.Builder
avoiding the need to create one manually viaListGeofencesRequest.builder()
- Parameters:
listGeofencesRequest
- AConsumer
that will call methods onListGeofencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGeofences operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeofencesPaginator
This is a variant of
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListGeofencesPublisher publisher = client.listGeofencesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListGeofencesPublisher publisher = client.listGeofencesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListGeofencesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListGeofencesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation.- Parameters:
listGeofencesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeofencesPaginator
default ListGeofencesPublisher listGeofencesPaginator(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest) This is a variant of
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListGeofencesPublisher publisher = client.listGeofencesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListGeofencesPublisher publisher = client.listGeofencesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListGeofencesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListGeofencesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation.
This is a convenience which creates an instance of the
ListGeofencesRequest.Builder
avoiding the need to create one manually viaListGeofencesRequest.builder()
- Parameters:
listGeofencesRequest
- AConsumer
that will call methods onListGeofencesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKeys
Lists API key resources in your Amazon Web Services account.
- Parameters:
listKeysRequest
-- Returns:
- A Java Future containing the result of the ListKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKeys
default CompletableFuture<ListKeysResponse> listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest) Lists API key resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListKeysRequest.Builder
avoiding the need to create one manually viaListKeysRequest.builder()
- Parameters:
listKeysRequest
- AConsumer
that will call methods onListKeysRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKeysPaginator
This is a variant of
listKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListKeysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListKeysResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)
operation.- Parameters:
listKeysRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKeysPaginator
This is a variant of
listKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListKeysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListKeysResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)
operation.
This is a convenience which creates an instance of the
ListKeysRequest.Builder
avoiding the need to create one manually viaListKeysRequest.builder()
- Parameters:
listKeysRequest
- AConsumer
that will call methods onListKeysRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMaps
Lists map resources in your Amazon Web Services account.
- Parameters:
listMapsRequest
-- Returns:
- A Java Future containing the result of the ListMaps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMaps
default CompletableFuture<ListMapsResponse> listMaps(Consumer<ListMapsRequest.Builder> listMapsRequest) Lists map resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListMapsRequest.Builder
avoiding the need to create one manually viaListMapsRequest.builder()
- Parameters:
listMapsRequest
- AConsumer
that will call methods onListMapsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMaps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMapsPaginator
This is a variant of
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListMapsPublisher publisher = client.listMapsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListMapsPublisher publisher = client.listMapsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListMapsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListMapsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation.- Parameters:
listMapsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMapsPaginator
This is a variant of
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListMapsPublisher publisher = client.listMapsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListMapsPublisher publisher = client.listMapsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListMapsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListMapsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation.
This is a convenience which creates an instance of the
ListMapsRequest.Builder
avoiding the need to create one manually viaListMapsRequest.builder()
- Parameters:
listMapsRequest
- AConsumer
that will call methods onListMapsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaceIndexes
default CompletableFuture<ListPlaceIndexesResponse> listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest) Lists place index resources in your Amazon Web Services account.
- Parameters:
listPlaceIndexesRequest
-- Returns:
- A Java Future containing the result of the ListPlaceIndexes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaceIndexes
default CompletableFuture<ListPlaceIndexesResponse> listPlaceIndexes(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest) Lists place index resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListPlaceIndexesRequest.Builder
avoiding the need to create one manually viaListPlaceIndexesRequest.builder()
- Parameters:
listPlaceIndexesRequest
- AConsumer
that will call methods onListPlaceIndexesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPlaceIndexes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaceIndexesPaginator
default ListPlaceIndexesPublisher listPlaceIndexesPaginator(ListPlaceIndexesRequest listPlaceIndexesRequest) This is a variant of
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListPlaceIndexesPublisher publisher = client.listPlaceIndexesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListPlaceIndexesPublisher publisher = client.listPlaceIndexesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation.- Parameters:
listPlaceIndexesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaceIndexesPaginator
default ListPlaceIndexesPublisher listPlaceIndexesPaginator(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest) This is a variant of
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListPlaceIndexesPublisher publisher = client.listPlaceIndexesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListPlaceIndexesPublisher publisher = client.listPlaceIndexesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation.
This is a convenience which creates an instance of the
ListPlaceIndexesRequest.Builder
avoiding the need to create one manually viaListPlaceIndexesRequest.builder()
- Parameters:
listPlaceIndexesRequest
- AConsumer
that will call methods onListPlaceIndexesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRouteCalculators
default CompletableFuture<ListRouteCalculatorsResponse> listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest) Lists route calculator resources in your Amazon Web Services account.
- Parameters:
listRouteCalculatorsRequest
-- Returns:
- A Java Future containing the result of the ListRouteCalculators operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRouteCalculators
default CompletableFuture<ListRouteCalculatorsResponse> listRouteCalculators(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest) Lists route calculator resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListRouteCalculatorsRequest.Builder
avoiding the need to create one manually viaListRouteCalculatorsRequest.builder()
- Parameters:
listRouteCalculatorsRequest
- AConsumer
that will call methods onListRouteCalculatorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRouteCalculators operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRouteCalculatorsPaginator
default ListRouteCalculatorsPublisher listRouteCalculatorsPaginator(ListRouteCalculatorsRequest listRouteCalculatorsRequest) This is a variant of
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListRouteCalculatorsPublisher publisher = client.listRouteCalculatorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsPublisher publisher = client.listRouteCalculatorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation.- Parameters:
listRouteCalculatorsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRouteCalculatorsPaginator
default ListRouteCalculatorsPublisher listRouteCalculatorsPaginator(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest) This is a variant of
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListRouteCalculatorsPublisher publisher = client.listRouteCalculatorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsPublisher publisher = client.listRouteCalculatorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation.
This is a convenience which creates an instance of the
ListRouteCalculatorsRequest.Builder
avoiding the need to create one manually viaListRouteCalculatorsRequest.builder()
- Parameters:
listRouteCalculatorsRequest
- AConsumer
that will call methods onListRouteCalculatorsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Location resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Location resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrackerConsumers
default CompletableFuture<ListTrackerConsumersResponse> listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest) Lists geofence collections currently associated to the given tracker resource.
- Parameters:
listTrackerConsumersRequest
-- Returns:
- A Java Future containing the result of the ListTrackerConsumers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrackerConsumers
default CompletableFuture<ListTrackerConsumersResponse> listTrackerConsumers(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest) Lists geofence collections currently associated to the given tracker resource.
This is a convenience which creates an instance of the
ListTrackerConsumersRequest.Builder
avoiding the need to create one manually viaListTrackerConsumersRequest.builder()
- Parameters:
listTrackerConsumersRequest
- AConsumer
that will call methods onListTrackerConsumersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTrackerConsumers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrackerConsumersPaginator
default ListTrackerConsumersPublisher listTrackerConsumersPaginator(ListTrackerConsumersRequest listTrackerConsumersRequest) This is a variant of
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListTrackerConsumersPublisher publisher = client.listTrackerConsumersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListTrackerConsumersPublisher publisher = client.listTrackerConsumersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation.- Parameters:
listTrackerConsumersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrackerConsumersPaginator
default ListTrackerConsumersPublisher listTrackerConsumersPaginator(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest) This is a variant of
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListTrackerConsumersPublisher publisher = client.listTrackerConsumersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListTrackerConsumersPublisher publisher = client.listTrackerConsumersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation.
This is a convenience which creates an instance of the
ListTrackerConsumersRequest.Builder
avoiding the need to create one manually viaListTrackerConsumersRequest.builder()
- Parameters:
listTrackerConsumersRequest
- AConsumer
that will call methods onListTrackerConsumersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrackers
default CompletableFuture<ListTrackersResponse> listTrackers(ListTrackersRequest listTrackersRequest) Lists tracker resources in your Amazon Web Services account.
- Parameters:
listTrackersRequest
-- Returns:
- A Java Future containing the result of the ListTrackers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrackers
default CompletableFuture<ListTrackersResponse> listTrackers(Consumer<ListTrackersRequest.Builder> listTrackersRequest) Lists tracker resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListTrackersRequest.Builder
avoiding the need to create one manually viaListTrackersRequest.builder()
- Parameters:
listTrackersRequest
- AConsumer
that will call methods onListTrackersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTrackers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrackersPaginator
This is a variant of
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListTrackersPublisher publisher = client.listTrackersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListTrackersPublisher publisher = client.listTrackersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListTrackersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListTrackersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation.- Parameters:
listTrackersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrackersPaginator
default ListTrackersPublisher listTrackersPaginator(Consumer<ListTrackersRequest.Builder> listTrackersRequest) This is a variant of
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.location.paginators.ListTrackersPublisher publisher = client.listTrackersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.location.paginators.ListTrackersPublisher publisher = client.listTrackersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListTrackersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.location.model.ListTrackersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation.
This is a convenience which creates an instance of the
ListTrackersRequest.Builder
avoiding the need to create one manually viaListTrackersRequest.builder()
- Parameters:
listTrackersRequest
- AConsumer
that will call methods onListTrackersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putGeofence
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:
- A Java Future containing the result of the PutGeofence operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putGeofence
default CompletableFuture<PutGeofenceResponse> putGeofence(Consumer<PutGeofenceRequest.Builder> 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.
This is a convenience which creates an instance of the
PutGeofenceRequest.Builder
avoiding the need to create one manually viaPutGeofenceRequest.builder()
- Parameters:
putGeofenceRequest
- AConsumer
that will call methods onPutGeofenceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutGeofence operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPlaceIndexForPosition
default CompletableFuture<SearchPlaceIndexForPositionResponse> 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:
- A Java Future containing the result of the SearchPlaceIndexForPosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPlaceIndexForPosition
default CompletableFuture<SearchPlaceIndexForPositionResponse> searchPlaceIndexForPosition(Consumer<SearchPlaceIndexForPositionRequest.Builder> 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.
This is a convenience which creates an instance of the
SearchPlaceIndexForPositionRequest.Builder
avoiding the need to create one manually viaSearchPlaceIndexForPositionRequest.builder()
- Parameters:
searchPlaceIndexForPositionRequest
- AConsumer
that will call methods onSearchPlaceIndexForPositionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchPlaceIndexForPosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPlaceIndexForSuggestions
default CompletableFuture<SearchPlaceIndexForSuggestionsResponse> 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 usingFilterBBox
. These parameters are mutually exclusive; using bothBiasPosition
andFilterBBox
in the same command returns an error.- Parameters:
searchPlaceIndexForSuggestionsRequest
-- Returns:
- A Java Future containing the result of the SearchPlaceIndexForSuggestions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPlaceIndexForSuggestions
default CompletableFuture<SearchPlaceIndexForSuggestionsResponse> searchPlaceIndexForSuggestions(Consumer<SearchPlaceIndexForSuggestionsRequest.Builder> 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 usingFilterBBox
. These parameters are mutually exclusive; using bothBiasPosition
andFilterBBox
in the same command returns an error.
This is a convenience which creates an instance of the
SearchPlaceIndexForSuggestionsRequest.Builder
avoiding the need to create one manually viaSearchPlaceIndexForSuggestionsRequest.builder()
- Parameters:
searchPlaceIndexForSuggestionsRequest
- AConsumer
that will call methods onSearchPlaceIndexForSuggestionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchPlaceIndexForSuggestions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPlaceIndexForText
default CompletableFuture<SearchPlaceIndexForTextResponse> 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 usingFilterBBox
. Providing both parameters simultaneously returns an error.Search results are returned in order of highest to lowest relevance.
- Parameters:
searchPlaceIndexForTextRequest
-- Returns:
- A Java Future containing the result of the SearchPlaceIndexForText operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPlaceIndexForText
default CompletableFuture<SearchPlaceIndexForTextResponse> searchPlaceIndexForText(Consumer<SearchPlaceIndexForTextRequest.Builder> 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 usingFilterBBox
. Providing both parameters simultaneously returns an error.Search results are returned in order of highest to lowest relevance.
This is a convenience which creates an instance of the
SearchPlaceIndexForTextRequest.Builder
avoiding the need to create one manually viaSearchPlaceIndexForTextRequest.builder()
- Parameters:
searchPlaceIndexForTextRequest
- AConsumer
that will call methods onSearchPlaceIndexForTextRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchPlaceIndexForText operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified Amazon Location resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified Amazon Location resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGeofenceCollection
default CompletableFuture<UpdateGeofenceCollectionResponse> updateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest) Updates the specified properties of a given geofence collection.
- Parameters:
updateGeofenceCollectionRequest
-- Returns:
- A Java Future containing the result of the UpdateGeofenceCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGeofenceCollection
default CompletableFuture<UpdateGeofenceCollectionResponse> updateGeofenceCollection(Consumer<UpdateGeofenceCollectionRequest.Builder> updateGeofenceCollectionRequest) Updates the specified properties of a given geofence collection.
This is a convenience which creates an instance of the
UpdateGeofenceCollectionRequest.Builder
avoiding the need to create one manually viaUpdateGeofenceCollectionRequest.builder()
- Parameters:
updateGeofenceCollectionRequest
- AConsumer
that will call methods onUpdateGeofenceCollectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGeofenceCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKey
Updates the specified properties of a given API key resource.
- Parameters:
updateKeyRequest
-- Returns:
- A Java Future containing the result of the UpdateKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKey
default CompletableFuture<UpdateKeyResponse> updateKey(Consumer<UpdateKeyRequest.Builder> updateKeyRequest) Updates the specified properties of a given API key resource.
This is a convenience which creates an instance of the
UpdateKeyRequest.Builder
avoiding the need to create one manually viaUpdateKeyRequest.builder()
- Parameters:
updateKeyRequest
- AConsumer
that will call methods onUpdateKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMap
Updates the specified properties of a given map resource.
- Parameters:
updateMapRequest
-- Returns:
- A Java Future containing the result of the UpdateMap operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMap
default CompletableFuture<UpdateMapResponse> updateMap(Consumer<UpdateMapRequest.Builder> updateMapRequest) Updates the specified properties of a given map resource.
This is a convenience which creates an instance of the
UpdateMapRequest.Builder
avoiding the need to create one manually viaUpdateMapRequest.builder()
- Parameters:
updateMapRequest
- AConsumer
that will call methods onUpdateMapRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMap operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePlaceIndex
default CompletableFuture<UpdatePlaceIndexResponse> updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest) Updates the specified properties of a given place index resource.
- Parameters:
updatePlaceIndexRequest
-- Returns:
- A Java Future containing the result of the UpdatePlaceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePlaceIndex
default CompletableFuture<UpdatePlaceIndexResponse> updatePlaceIndex(Consumer<UpdatePlaceIndexRequest.Builder> updatePlaceIndexRequest) Updates the specified properties of a given place index resource.
This is a convenience which creates an instance of the
UpdatePlaceIndexRequest.Builder
avoiding the need to create one manually viaUpdatePlaceIndexRequest.builder()
- Parameters:
updatePlaceIndexRequest
- AConsumer
that will call methods onUpdatePlaceIndexRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePlaceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRouteCalculator
default CompletableFuture<UpdateRouteCalculatorResponse> updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest) Updates the specified properties for a given route calculator resource.
- Parameters:
updateRouteCalculatorRequest
-- Returns:
- A Java Future containing the result of the UpdateRouteCalculator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRouteCalculator
default CompletableFuture<UpdateRouteCalculatorResponse> updateRouteCalculator(Consumer<UpdateRouteCalculatorRequest.Builder> updateRouteCalculatorRequest) Updates the specified properties for a given route calculator resource.
This is a convenience which creates an instance of the
UpdateRouteCalculatorRequest.Builder
avoiding the need to create one manually viaUpdateRouteCalculatorRequest.builder()
- Parameters:
updateRouteCalculatorRequest
- AConsumer
that will call methods onUpdateRouteCalculatorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRouteCalculator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTracker
default CompletableFuture<UpdateTrackerResponse> updateTracker(UpdateTrackerRequest updateTrackerRequest) Updates the specified properties of a given tracker resource.
- Parameters:
updateTrackerRequest
-- Returns:
- A Java Future containing the result of the UpdateTracker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTracker
default CompletableFuture<UpdateTrackerResponse> updateTracker(Consumer<UpdateTrackerRequest.Builder> updateTrackerRequest) Updates the specified properties of a given tracker resource.
This is a convenience which creates an instance of the
UpdateTrackerRequest.Builder
avoiding the need to create one manually viaUpdateTrackerRequest.builder()
- Parameters:
updateTrackerRequest
- AConsumer
that will call methods onUpdateTrackerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTracker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LocationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aLocationAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aLocationAsyncClient
.
-