Interface LocationClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface LocationClient extends AwsClient
Service client for accessing Amazon Location Service. This can be created using the staticbuilder()method."Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AssociateTrackerConsumerResponseassociateTrackerConsumer(Consumer<AssociateTrackerConsumerRequest.Builder> associateTrackerConsumerRequest)Creates an association between a geofence collection and a tracker resource.default AssociateTrackerConsumerResponseassociateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)Creates an association between a geofence collection and a tracker resource.default BatchDeleteDevicePositionHistoryResponsebatchDeleteDevicePositionHistory(Consumer<BatchDeleteDevicePositionHistoryRequest.Builder> batchDeleteDevicePositionHistoryRequest)Deletes the position history of one or more devices from a tracker resource.default BatchDeleteDevicePositionHistoryResponsebatchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest)Deletes the position history of one or more devices from a tracker resource.default BatchDeleteGeofenceResponsebatchDeleteGeofence(Consumer<BatchDeleteGeofenceRequest.Builder> batchDeleteGeofenceRequest)Deletes a batch of geofences from a geofence collection.default BatchDeleteGeofenceResponsebatchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)Deletes a batch of geofences from a geofence collection.default BatchEvaluateGeofencesResponsebatchEvaluateGeofences(Consumer<BatchEvaluateGeofencesRequest.Builder> batchEvaluateGeofencesRequest)Evaluates device positions against the geofence geometries from a given geofence collection.default BatchEvaluateGeofencesResponsebatchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)Evaluates device positions against the geofence geometries from a given geofence collection.default BatchGetDevicePositionResponsebatchGetDevicePosition(Consumer<BatchGetDevicePositionRequest.Builder> batchGetDevicePositionRequest)Lists the latest device positions for requested devices.default BatchGetDevicePositionResponsebatchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)Lists the latest device positions for requested devices.default BatchPutGeofenceResponsebatchPutGeofence(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.default BatchPutGeofenceResponsebatchPutGeofence(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.default BatchUpdateDevicePositionResponsebatchUpdateDevicePosition(Consumer<BatchUpdateDevicePositionRequest.Builder> batchUpdateDevicePositionRequest)Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).default BatchUpdateDevicePositionResponsebatchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).static LocationClientBuilderbuilder()Create a builder that can be used to configure and create aLocationClient.default CalculateRouteResponsecalculateRoute(Consumer<CalculateRouteRequest.Builder> calculateRouteRequest)Calculates a route given the following required parameters:DeparturePositionandDestinationPosition.default CalculateRouteResponsecalculateRoute(CalculateRouteRequest calculateRouteRequest)Calculates a route given the following required parameters:DeparturePositionandDestinationPosition.default CalculateRouteMatrixResponsecalculateRouteMatrix(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest)Calculates a route matrix given the following required parameters:DeparturePositionsandDestinationPositions.default CalculateRouteMatrixResponsecalculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)Calculates a route matrix given the following required parameters:DeparturePositionsandDestinationPositions.static LocationClientcreate()Create aLocationClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateGeofenceCollectionResponsecreateGeofenceCollection(Consumer<CreateGeofenceCollectionRequest.Builder> createGeofenceCollectionRequest)Creates a geofence collection, which manages and stores geofences.default CreateGeofenceCollectionResponsecreateGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)Creates a geofence collection, which manages and stores geofences.default CreateKeyResponsecreateKey(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 CreateKeyResponsecreateKey(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 CreateMapResponsecreateMap(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 CreateMapResponsecreateMap(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.default CreatePlaceIndexResponsecreatePlaceIndex(Consumer<CreatePlaceIndexRequest.Builder> createPlaceIndexRequest)Creates a place index resource in your Amazon Web Services account.default CreatePlaceIndexResponsecreatePlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)Creates a place index resource in your Amazon Web Services account.default CreateRouteCalculatorResponsecreateRouteCalculator(Consumer<CreateRouteCalculatorRequest.Builder> createRouteCalculatorRequest)Creates a route calculator resource in your Amazon Web Services account.default CreateRouteCalculatorResponsecreateRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest)Creates a route calculator resource in your Amazon Web Services account.default CreateTrackerResponsecreateTracker(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 CreateTrackerResponsecreateTracker(CreateTrackerRequest createTrackerRequest)Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.default DeleteGeofenceCollectionResponsedeleteGeofenceCollection(Consumer<DeleteGeofenceCollectionRequest.Builder> deleteGeofenceCollectionRequest)Deletes a geofence collection from your Amazon Web Services account.default DeleteGeofenceCollectionResponsedeleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)Deletes a geofence collection from your Amazon Web Services account.default DeleteKeyResponsedeleteKey(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest)Deletes the specified API key.default DeleteKeyResponsedeleteKey(DeleteKeyRequest deleteKeyRequest)Deletes the specified API key.default DeleteMapResponsedeleteMap(Consumer<DeleteMapRequest.Builder> deleteMapRequest)Deletes a map resource from your Amazon Web Services account.default DeleteMapResponsedeleteMap(DeleteMapRequest deleteMapRequest)Deletes a map resource from your Amazon Web Services account.default DeletePlaceIndexResponsedeletePlaceIndex(Consumer<DeletePlaceIndexRequest.Builder> deletePlaceIndexRequest)Deletes a place index resource from your Amazon Web Services account.default DeletePlaceIndexResponsedeletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)Deletes a place index resource from your Amazon Web Services account.default DeleteRouteCalculatorResponsedeleteRouteCalculator(Consumer<DeleteRouteCalculatorRequest.Builder> deleteRouteCalculatorRequest)Deletes a route calculator resource from your Amazon Web Services account.default DeleteRouteCalculatorResponsedeleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest)Deletes a route calculator resource from your Amazon Web Services account.default DeleteTrackerResponsedeleteTracker(Consumer<DeleteTrackerRequest.Builder> deleteTrackerRequest)Deletes a tracker resource from your Amazon Web Services account.default DeleteTrackerResponsedeleteTracker(DeleteTrackerRequest deleteTrackerRequest)Deletes a tracker resource from your Amazon Web Services account.default DescribeGeofenceCollectionResponsedescribeGeofenceCollection(Consumer<DescribeGeofenceCollectionRequest.Builder> describeGeofenceCollectionRequest)Retrieves the geofence collection details.default DescribeGeofenceCollectionResponsedescribeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)Retrieves the geofence collection details.default DescribeKeyResponsedescribeKey(Consumer<DescribeKeyRequest.Builder> describeKeyRequest)Retrieves the API key resource details.default DescribeKeyResponsedescribeKey(DescribeKeyRequest describeKeyRequest)Retrieves the API key resource details.default DescribeMapResponsedescribeMap(Consumer<DescribeMapRequest.Builder> describeMapRequest)Retrieves the map resource details.default DescribeMapResponsedescribeMap(DescribeMapRequest describeMapRequest)Retrieves the map resource details.default DescribePlaceIndexResponsedescribePlaceIndex(Consumer<DescribePlaceIndexRequest.Builder> describePlaceIndexRequest)Retrieves the place index resource details.default DescribePlaceIndexResponsedescribePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)Retrieves the place index resource details.default DescribeRouteCalculatorResponsedescribeRouteCalculator(Consumer<DescribeRouteCalculatorRequest.Builder> describeRouteCalculatorRequest)Retrieves the route calculator resource details.default DescribeRouteCalculatorResponsedescribeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest)Retrieves the route calculator resource details.default DescribeTrackerResponsedescribeTracker(Consumer<DescribeTrackerRequest.Builder> describeTrackerRequest)Retrieves the tracker resource details.default DescribeTrackerResponsedescribeTracker(DescribeTrackerRequest describeTrackerRequest)Retrieves the tracker resource details.default DisassociateTrackerConsumerResponsedisassociateTrackerConsumer(Consumer<DisassociateTrackerConsumerRequest.Builder> disassociateTrackerConsumerRequest)Removes the association between a tracker resource and a geofence collection.default DisassociateTrackerConsumerResponsedisassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)Removes the association between a tracker resource and a geofence collection.default GetDevicePositionResponsegetDevicePosition(Consumer<GetDevicePositionRequest.Builder> getDevicePositionRequest)Retrieves a device's most recent position according to its sample time.default GetDevicePositionResponsegetDevicePosition(GetDevicePositionRequest getDevicePositionRequest)Retrieves a device's most recent position according to its sample time.default GetDevicePositionHistoryResponsegetDevicePositionHistory(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest)Retrieves the device position history from a tracker resource within a specified range of time.default GetDevicePositionHistoryResponsegetDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)Retrieves the device position history from a tracker resource within a specified range of time.default GetDevicePositionHistoryIterablegetDevicePositionHistoryPaginator(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest)This is a variant ofgetDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)operation.default GetDevicePositionHistoryIterablegetDevicePositionHistoryPaginator(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)This is a variant ofgetDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)operation.default GetGeofenceResponsegetGeofence(Consumer<GetGeofenceRequest.Builder> getGeofenceRequest)Retrieves the geofence details from a geofence collection.default GetGeofenceResponsegetGeofence(GetGeofenceRequest getGeofenceRequest)Retrieves the geofence details from a geofence collection.default GetMapGlyphsResponsegetMapGlyphs(Consumer<GetMapGlyphsRequest.Builder> getMapGlyphsRequest)Retrieves glyphs used to display labels on a map.default GetMapGlyphsResponsegetMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)Retrieves glyphs used to display labels on a map.default GetMapSpritesResponsegetMapSprites(Consumer<GetMapSpritesRequest.Builder> getMapSpritesRequest)Retrieves the sprite sheet corresponding to a map resource.default GetMapSpritesResponsegetMapSprites(GetMapSpritesRequest getMapSpritesRequest)Retrieves the sprite sheet corresponding to a map resource.default GetMapStyleDescriptorResponsegetMapStyleDescriptor(Consumer<GetMapStyleDescriptorRequest.Builder> getMapStyleDescriptorRequest)Retrieves the map style descriptor from a map resource.default GetMapStyleDescriptorResponsegetMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)Retrieves the map style descriptor from a map resource.default GetMapTileResponsegetMapTile(Consumer<GetMapTileRequest.Builder> getMapTileRequest)Retrieves a vector data tile from the map resource.default GetMapTileResponsegetMapTile(GetMapTileRequest getMapTileRequest)Retrieves a vector data tile from the map resource.default GetPlaceResponsegetPlace(Consumer<GetPlaceRequest.Builder> getPlaceRequest)Finds a place by its unique ID.default GetPlaceResponsegetPlace(GetPlaceRequest getPlaceRequest)Finds a place by its unique ID.default ListDevicePositionsResponselistDevicePositions(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest)A batch request to retrieve all device positions.default ListDevicePositionsResponselistDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)A batch request to retrieve all device positions.default ListDevicePositionsIterablelistDevicePositionsPaginator(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest)This is a variant oflistDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)operation.default ListDevicePositionsIterablelistDevicePositionsPaginator(ListDevicePositionsRequest listDevicePositionsRequest)This is a variant oflistDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)operation.default ListGeofenceCollectionsResponselistGeofenceCollections(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest)Lists geofence collections in your Amazon Web Services account.default ListGeofenceCollectionsResponselistGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)Lists geofence collections in your Amazon Web Services account.default ListGeofenceCollectionsIterablelistGeofenceCollectionsPaginator(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest)This is a variant oflistGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)operation.default ListGeofenceCollectionsIterablelistGeofenceCollectionsPaginator(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)This is a variant oflistGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)operation.default ListGeofencesResponselistGeofences(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest)Lists geofences stored in a given geofence collection.default ListGeofencesResponselistGeofences(ListGeofencesRequest listGeofencesRequest)Lists geofences stored in a given geofence collection.default ListGeofencesIterablelistGeofencesPaginator(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest)This is a variant oflistGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)operation.default ListGeofencesIterablelistGeofencesPaginator(ListGeofencesRequest listGeofencesRequest)This is a variant oflistGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)operation.default ListKeysResponselistKeys(Consumer<ListKeysRequest.Builder> listKeysRequest)Lists API key resources in your Amazon Web Services account.default ListKeysResponselistKeys(ListKeysRequest listKeysRequest)Lists API key resources in your Amazon Web Services account.default ListKeysIterablelistKeysPaginator(Consumer<ListKeysRequest.Builder> listKeysRequest)This is a variant oflistKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)operation.default ListKeysIterablelistKeysPaginator(ListKeysRequest listKeysRequest)This is a variant oflistKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)operation.default ListMapsResponselistMaps(Consumer<ListMapsRequest.Builder> listMapsRequest)Lists map resources in your Amazon Web Services account.default ListMapsResponselistMaps(ListMapsRequest listMapsRequest)Lists map resources in your Amazon Web Services account.default ListMapsIterablelistMapsPaginator(Consumer<ListMapsRequest.Builder> listMapsRequest)This is a variant oflistMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)operation.default ListMapsIterablelistMapsPaginator(ListMapsRequest listMapsRequest)This is a variant oflistMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)operation.default ListPlaceIndexesResponselistPlaceIndexes(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest)Lists place index resources in your Amazon Web Services account.default ListPlaceIndexesResponselistPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)Lists place index resources in your Amazon Web Services account.default ListPlaceIndexesIterablelistPlaceIndexesPaginator(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest)This is a variant oflistPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)operation.default ListPlaceIndexesIterablelistPlaceIndexesPaginator(ListPlaceIndexesRequest listPlaceIndexesRequest)This is a variant oflistPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)operation.default ListRouteCalculatorsResponselistRouteCalculators(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest)Lists route calculator resources in your Amazon Web Services account.default ListRouteCalculatorsResponselistRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest)Lists route calculator resources in your Amazon Web Services account.default ListRouteCalculatorsIterablelistRouteCalculatorsPaginator(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest)This is a variant oflistRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)operation.default ListRouteCalculatorsIterablelistRouteCalculatorsPaginator(ListRouteCalculatorsRequest listRouteCalculatorsRequest)This is a variant oflistRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Returns a list of tags that are applied to the specified Amazon Location resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Returns a list of tags that are applied to the specified Amazon Location resource.default ListTrackerConsumersResponselistTrackerConsumers(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest)Lists geofence collections currently associated to the given tracker resource.default ListTrackerConsumersResponselistTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)Lists geofence collections currently associated to the given tracker resource.default ListTrackerConsumersIterablelistTrackerConsumersPaginator(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest)This is a variant oflistTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)operation.default ListTrackerConsumersIterablelistTrackerConsumersPaginator(ListTrackerConsumersRequest listTrackerConsumersRequest)This is a variant oflistTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)operation.default ListTrackersResponselistTrackers(Consumer<ListTrackersRequest.Builder> listTrackersRequest)Lists tracker resources in your Amazon Web Services account.default ListTrackersResponselistTrackers(ListTrackersRequest listTrackersRequest)Lists tracker resources in your Amazon Web Services account.default ListTrackersIterablelistTrackersPaginator(Consumer<ListTrackersRequest.Builder> listTrackersRequest)This is a variant oflistTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)operation.default ListTrackersIterablelistTrackersPaginator(ListTrackersRequest listTrackersRequest)This is a variant oflistTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)operation.default PutGeofenceResponseputGeofence(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 PutGeofenceResponseputGeofence(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.default SearchPlaceIndexForPositionResponsesearchPlaceIndexForPosition(Consumer<SearchPlaceIndexForPositionRequest.Builder> searchPlaceIndexForPositionRequest)Reverse geocodes a given coordinate and returns a legible address.default SearchPlaceIndexForPositionResponsesearchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)Reverse geocodes a given coordinate and returns a legible address.default SearchPlaceIndexForSuggestionsResponsesearchPlaceIndexForSuggestions(Consumer<SearchPlaceIndexForSuggestionsRequest.Builder> searchPlaceIndexForSuggestionsRequest)Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.default SearchPlaceIndexForSuggestionsResponsesearchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest)Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.default SearchPlaceIndexForTextResponsesearchPlaceIndexForText(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.default SearchPlaceIndexForTextResponsesearchPlaceIndexForText(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.default LocationServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes one or more tags from the specified Amazon Location resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes one or more tags from the specified Amazon Location resource.default UpdateGeofenceCollectionResponseupdateGeofenceCollection(Consumer<UpdateGeofenceCollectionRequest.Builder> updateGeofenceCollectionRequest)Updates the specified properties of a given geofence collection.default UpdateGeofenceCollectionResponseupdateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest)Updates the specified properties of a given geofence collection.default UpdateKeyResponseupdateKey(Consumer<UpdateKeyRequest.Builder> updateKeyRequest)Updates the specified properties of a given API key resource.default UpdateKeyResponseupdateKey(UpdateKeyRequest updateKeyRequest)Updates the specified properties of a given API key resource.default UpdateMapResponseupdateMap(Consumer<UpdateMapRequest.Builder> updateMapRequest)Updates the specified properties of a given map resource.default UpdateMapResponseupdateMap(UpdateMapRequest updateMapRequest)Updates the specified properties of a given map resource.default UpdatePlaceIndexResponseupdatePlaceIndex(Consumer<UpdatePlaceIndexRequest.Builder> updatePlaceIndexRequest)Updates the specified properties of a given place index resource.default UpdatePlaceIndexResponseupdatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest)Updates the specified properties of a given place index resource.default UpdateRouteCalculatorResponseupdateRouteCalculator(Consumer<UpdateRouteCalculatorRequest.Builder> updateRouteCalculatorRequest)Updates the specified properties for a given route calculator resource.default UpdateRouteCalculatorResponseupdateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest)Updates the specified properties for a given route calculator resource.default UpdateTrackerResponseupdateTracker(Consumer<UpdateTrackerRequest.Builder> updateTrackerRequest)Updates the specified properties of a given tracker resource.default UpdateTrackerResponseupdateTracker(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateTrackerConsumer
default AssociateTrackerConsumerResponse associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
You can associate up to five geofence collections to each tracker resource.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
- Parameters:
associateTrackerConsumerRequest-- Returns:
- Result of the AssociateTrackerConsumer operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
associateTrackerConsumer
default AssociateTrackerConsumerResponse associateTrackerConsumer(Consumer<AssociateTrackerConsumerRequest.Builder> associateTrackerConsumerRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaAssociateTrackerConsumerRequest.builder()- Parameters:
associateTrackerConsumerRequest- AConsumerthat will call methods onAssociateTrackerConsumerRequest.Builderto create a request.- Returns:
- Result of the AssociateTrackerConsumer operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteDevicePositionHistory
default BatchDeleteDevicePositionHistoryResponse batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes the position history of one or more devices from a tracker resource.
- Parameters:
batchDeleteDevicePositionHistoryRequest-- Returns:
- Result of the BatchDeleteDevicePositionHistory operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteDevicePositionHistory
default BatchDeleteDevicePositionHistoryResponse batchDeleteDevicePositionHistory(Consumer<BatchDeleteDevicePositionHistoryRequest.Builder> batchDeleteDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes the position history of one or more devices from a tracker resource.
This is a convenience which creates an instance of the
BatchDeleteDevicePositionHistoryRequest.Builderavoiding the need to create one manually viaBatchDeleteDevicePositionHistoryRequest.builder()- Parameters:
batchDeleteDevicePositionHistoryRequest- AConsumerthat will call methods onBatchDeleteDevicePositionHistoryRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteDevicePositionHistory operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteGeofence
default BatchDeleteGeofenceResponse batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
- Parameters:
batchDeleteGeofenceRequest-- Returns:
- Result of the BatchDeleteGeofence operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteGeofence
default BatchDeleteGeofenceResponse batchDeleteGeofence(Consumer<BatchDeleteGeofenceRequest.Builder> batchDeleteGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaBatchDeleteGeofenceRequest.builder()- Parameters:
batchDeleteGeofenceRequest- AConsumerthat will call methods onBatchDeleteGeofenceRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteGeofence operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchEvaluateGeofences
default BatchEvaluateGeofencesResponse batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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:
-
ENTERif Amazon Location determines that the tracked device has entered a geofenced area. -
EXITif 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
Accuracyof aDevicePositionUpdate.The
DeviceIDis used as a string to represent the device. You do not need to have aTrackerassociated with theDeviceID.- Parameters:
batchEvaluateGeofencesRequest-- Returns:
- Result of the BatchEvaluateGeofences operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
batchEvaluateGeofences
default BatchEvaluateGeofencesResponse batchEvaluateGeofences(Consumer<BatchEvaluateGeofencesRequest.Builder> batchEvaluateGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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:
-
ENTERif Amazon Location determines that the tracked device has entered a geofenced area. -
EXITif 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
Accuracyof aDevicePositionUpdate.The
DeviceIDis used as a string to represent the device. You do not need to have aTrackerassociated with theDeviceID.
This is a convenience which creates an instance of the
BatchEvaluateGeofencesRequest.Builderavoiding the need to create one manually viaBatchEvaluateGeofencesRequest.builder()- Parameters:
batchEvaluateGeofencesRequest- AConsumerthat will call methods onBatchEvaluateGeofencesRequest.Builderto create a request.- Returns:
- Result of the BatchEvaluateGeofences operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
batchGetDevicePosition
default BatchGetDevicePositionResponse batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists the latest device positions for requested devices.
- Parameters:
batchGetDevicePositionRequest-- Returns:
- Result of the BatchGetDevicePosition operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetDevicePosition
default BatchGetDevicePositionResponse batchGetDevicePosition(Consumer<BatchGetDevicePositionRequest.Builder> batchGetDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists the latest device positions for requested devices.
This is a convenience which creates an instance of the
BatchGetDevicePositionRequest.Builderavoiding the need to create one manually viaBatchGetDevicePositionRequest.builder()- Parameters:
batchGetDevicePositionRequest- AConsumerthat will call methods onBatchGetDevicePositionRequest.Builderto create a request.- Returns:
- Result of the BatchGetDevicePosition operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutGeofence
default BatchPutGeofenceResponse batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
- Parameters:
batchPutGeofenceRequest-- Returns:
- Result of the BatchPutGeofence operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutGeofence
default BatchPutGeofenceResponse batchPutGeofence(Consumer<BatchPutGeofenceRequest.Builder> batchPutGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaBatchPutGeofenceRequest.builder()- Parameters:
batchPutGeofenceRequest- AConsumerthat will call methods onBatchPutGeofenceRequest.Builderto create a request.- Returns:
- Result of the BatchPutGeofence operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchUpdateDevicePosition
default BatchUpdateDevicePositionResponse batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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
PositionFilteringproperty of the tracker. WhenPositionFilteringis 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
PositionFilteringis set toDistanceBasedfiltering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).When
PositionFilteringis set toAccuracyBasedfiltering, 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. IfPositionFilteringis set toAccuracyBasedfiltering, Amazon Location uses the default value{ "Horizontal": 0}when accuracy is not provided on aDevicePositionUpdate.- Parameters:
batchUpdateDevicePositionRequest-- Returns:
- Result of the BatchUpdateDevicePosition operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchUpdateDevicePosition
default BatchUpdateDevicePositionResponse batchUpdateDevicePosition(Consumer<BatchUpdateDevicePositionRequest.Builder> batchUpdateDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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
PositionFilteringproperty of the tracker. WhenPositionFilteringis 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
PositionFilteringis set toDistanceBasedfiltering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).When
PositionFilteringis set toAccuracyBasedfiltering, 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. IfPositionFilteringis set toAccuracyBasedfiltering, 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.Builderavoiding the need to create one manually viaBatchUpdateDevicePositionRequest.builder()- Parameters:
batchUpdateDevicePositionRequest- AConsumerthat will call methods onBatchUpdateDevicePositionRequest.Builderto create a request.- Returns:
- Result of the BatchUpdateDevicePosition operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
calculateRoute
default CalculateRouteResponse calculateRoute(CalculateRouteRequest calculateRouteRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Calculates a route given the following required parameters:
DeparturePositionandDestinationPosition. 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
DepartureTimeorDepartNow. This calculates a route based on predictive traffic data at the given time.You can't specify both
DepartureTimeandDepartNowin 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
CarModeOptionsif traveling byCar, orTruckModeOptionsif traveling byTruck.If you specify
walkingfor the travel mode and your data provider is Esri, the start and destination must be within 40km.
- Parameters:
calculateRouteRequest-- Returns:
- Result of the CalculateRoute operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
calculateRoute
default CalculateRouteResponse calculateRoute(Consumer<CalculateRouteRequest.Builder> calculateRouteRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Calculates a route given the following required parameters:
DeparturePositionandDestinationPosition. 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
DepartureTimeorDepartNow. This calculates a route based on predictive traffic data at the given time.You can't specify both
DepartureTimeandDepartNowin 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
CarModeOptionsif traveling byCar, orTruckModeOptionsif traveling byTruck.If you specify
walkingfor 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.Builderavoiding the need to create one manually viaCalculateRouteRequest.builder()- Parameters:
calculateRouteRequest- AConsumerthat will call methods onCalculateRouteRequest.Builderto create a request.- Returns:
- Result of the CalculateRoute operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
calculateRouteMatrix
default CalculateRouteMatrixResponse calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Calculates a route matrix given the following required parameters:
DeparturePositionsandDestinationPositions.CalculateRouteMatrixcalculates 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,CalculateRouteMatrixwill 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 ofDeparturePositionstimes 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
DepartureTimeorDepartNow. This calculates routes based on predictive traffic data at the given time.You can't specify both
DepartureTimeandDepartNowin 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
CarModeOptionsif traveling byCar, orTruckModeOptionsif traveling byTruck.
- Parameters:
calculateRouteMatrixRequest-- Returns:
- Result of the CalculateRouteMatrix operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
calculateRouteMatrix
default CalculateRouteMatrixResponse calculateRouteMatrix(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Calculates a route matrix given the following required parameters:
DeparturePositionsandDestinationPositions.CalculateRouteMatrixcalculates 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,CalculateRouteMatrixwill 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 ofDeparturePositionstimes 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
DepartureTimeorDepartNow. This calculates routes based on predictive traffic data at the given time.You can't specify both
DepartureTimeandDepartNowin 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
CarModeOptionsif traveling byCar, orTruckModeOptionsif traveling byTruck.
This is a convenience which creates an instance of the
CalculateRouteMatrixRequest.Builderavoiding the need to create one manually viaCalculateRouteMatrixRequest.builder()- Parameters:
calculateRouteMatrixRequest- AConsumerthat will call methods onCalculateRouteMatrixRequest.Builderto create a request.- Returns:
- Result of the CalculateRouteMatrix operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createGeofenceCollection
default CreateGeofenceCollectionResponse createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a geofence collection, which manages and stores geofences.
- Parameters:
createGeofenceCollectionRequest-- Returns:
- Result of the CreateGeofenceCollection operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createGeofenceCollection
default CreateGeofenceCollectionResponse createGeofenceCollection(Consumer<CreateGeofenceCollectionRequest.Builder> createGeofenceCollectionRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a geofence collection, which manages and stores geofences.
This is a convenience which creates an instance of the
CreateGeofenceCollectionRequest.Builderavoiding the need to create one manually viaCreateGeofenceCollectionRequest.builder()- Parameters:
createGeofenceCollectionRequest- AConsumerthat will call methods onCreateGeofenceCollectionRequest.Builderto create a request.- Returns:
- Result of the CreateGeofenceCollection operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createKey
default CreateKeyResponse createKey(CreateKeyRequest createKeyRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.
For more information, see Using API keys.
- Parameters:
createKeyRequest-- Returns:
- Result of the CreateKey operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createKey
default CreateKeyResponse createKey(Consumer<CreateKeyRequest.Builder> createKeyRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaCreateKeyRequest.builder()- Parameters:
createKeyRequest- AConsumerthat will call methods onCreateKeyRequest.Builderto create a request.- Returns:
- Result of the CreateKey operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createMap
default CreateMapResponse createMap(CreateMapRequest createMapRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
- Parameters:
createMapRequest-- Returns:
- Result of the CreateMap operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createMap
default CreateMapResponse createMap(Consumer<CreateMapRequest.Builder> createMapRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaCreateMapRequest.builder()- Parameters:
createMapRequest- AConsumerthat will call methods onCreateMapRequest.Builderto create a request.- Returns:
- Result of the CreateMap operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPlaceIndex
default CreatePlaceIndexResponse createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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
SearchPlaceIndexForTextoperation, and reverse geocode coordinates by using theSearchPlaceIndexForPositionoperation, and enable autosuggestions by using theSearchPlaceIndexForSuggestionsoperation.If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
- Parameters:
createPlaceIndexRequest-- Returns:
- Result of the CreatePlaceIndex operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPlaceIndex
default CreatePlaceIndexResponse createPlaceIndex(Consumer<CreatePlaceIndexRequest.Builder> createPlaceIndexRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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
SearchPlaceIndexForTextoperation, and reverse geocode coordinates by using theSearchPlaceIndexForPositionoperation, and enable autosuggestions by using theSearchPlaceIndexForSuggestionsoperation.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.Builderavoiding the need to create one manually viaCreatePlaceIndexRequest.builder()- Parameters:
createPlaceIndexRequest- AConsumerthat will call methods onCreatePlaceIndexRequest.Builderto create a request.- Returns:
- Result of the CreatePlaceIndex operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createRouteCalculator
default CreateRouteCalculatorResponse createRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a route calculator resource in your Amazon Web Services account.
You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
- Parameters:
createRouteCalculatorRequest-- Returns:
- Result of the CreateRouteCalculator operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createRouteCalculator
default CreateRouteCalculatorResponse createRouteCalculator(Consumer<CreateRouteCalculatorRequest.Builder> createRouteCalculatorRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaCreateRouteCalculatorRequest.builder()- Parameters:
createRouteCalculatorRequest- AConsumerthat will call methods onCreateRouteCalculatorRequest.Builderto create a request.- Returns:
- Result of the CreateRouteCalculator operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createTracker
default CreateTrackerResponse createTracker(CreateTrackerRequest createTrackerRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
- Parameters:
createTrackerRequest-- Returns:
- Result of the CreateTracker operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
createTracker
default CreateTrackerResponse createTracker(Consumer<CreateTrackerRequest.Builder> createTrackerRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaCreateTrackerRequest.builder()- Parameters:
createTrackerRequest- AConsumerthat will call methods onCreateTrackerRequest.Builderto create a request.- Returns:
- Result of the CreateTracker operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ServiceQuotaExceededException- The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGeofenceCollection
default DeleteGeofenceCollectionResponse deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a geofence collection from your Amazon Web Services account.
This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
- Parameters:
deleteGeofenceCollectionRequest-- Returns:
- Result of the DeleteGeofenceCollection operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGeofenceCollection
default DeleteGeofenceCollectionResponse deleteGeofenceCollection(Consumer<DeleteGeofenceCollectionRequest.Builder> deleteGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaDeleteGeofenceCollectionRequest.builder()- Parameters:
deleteGeofenceCollectionRequest- AConsumerthat will call methods onDeleteGeofenceCollectionRequest.Builderto create a request.- Returns:
- Result of the DeleteGeofenceCollection operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteKey
default DeleteKeyResponse deleteKey(DeleteKeyRequest deleteKeyRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
- Parameters:
deleteKeyRequest-- Returns:
- Result of the DeleteKey operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteKey
default DeleteKeyResponse deleteKey(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaDeleteKeyRequest.builder()- Parameters:
deleteKeyRequest- AConsumerthat will call methods onDeleteKeyRequest.Builderto create a request.- Returns:
- Result of the DeleteKey operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMap
default DeleteMapResponse deleteMap(DeleteMapRequest deleteMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a map resource from your Amazon Web Services account.
This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
- Parameters:
deleteMapRequest-- Returns:
- Result of the DeleteMap operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMap
default DeleteMapResponse deleteMap(Consumer<DeleteMapRequest.Builder> deleteMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaDeleteMapRequest.builder()- Parameters:
deleteMapRequest- AConsumerthat will call methods onDeleteMapRequest.Builderto create a request.- Returns:
- Result of the DeleteMap operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePlaceIndex
default DeletePlaceIndexResponse deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a place index resource from your Amazon Web Services account.
This operation deletes the resource permanently.
- Parameters:
deletePlaceIndexRequest-- Returns:
- Result of the DeletePlaceIndex operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePlaceIndex
default DeletePlaceIndexResponse deletePlaceIndex(Consumer<DeletePlaceIndexRequest.Builder> deletePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaDeletePlaceIndexRequest.builder()- Parameters:
deletePlaceIndexRequest- AConsumerthat will call methods onDeletePlaceIndexRequest.Builderto create a request.- Returns:
- Result of the DeletePlaceIndex operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRouteCalculator
default DeleteRouteCalculatorResponse deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a route calculator resource from your Amazon Web Services account.
This operation deletes the resource permanently.
- Parameters:
deleteRouteCalculatorRequest-- Returns:
- Result of the DeleteRouteCalculator operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRouteCalculator
default DeleteRouteCalculatorResponse deleteRouteCalculator(Consumer<DeleteRouteCalculatorRequest.Builder> deleteRouteCalculatorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaDeleteRouteCalculatorRequest.builder()- Parameters:
deleteRouteCalculatorRequest- AConsumerthat will call methods onDeleteRouteCalculatorRequest.Builderto create a request.- Returns:
- Result of the DeleteRouteCalculator operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTracker
default DeleteTrackerResponse deleteTracker(DeleteTrackerRequest deleteTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a tracker resource from your Amazon Web Services account.
This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.
- Parameters:
deleteTrackerRequest-- Returns:
- Result of the DeleteTracker operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTracker
default DeleteTrackerResponse deleteTracker(Consumer<DeleteTrackerRequest.Builder> deleteTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaDeleteTrackerRequest.builder()- Parameters:
deleteTrackerRequest- AConsumerthat will call methods onDeleteTrackerRequest.Builderto create a request.- Returns:
- Result of the DeleteTracker operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGeofenceCollection
default DescribeGeofenceCollectionResponse describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the geofence collection details.
- Parameters:
describeGeofenceCollectionRequest-- Returns:
- Result of the DescribeGeofenceCollection operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGeofenceCollection
default DescribeGeofenceCollectionResponse describeGeofenceCollection(Consumer<DescribeGeofenceCollectionRequest.Builder> describeGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the geofence collection details.
This is a convenience which creates an instance of the
DescribeGeofenceCollectionRequest.Builderavoiding the need to create one manually viaDescribeGeofenceCollectionRequest.builder()- Parameters:
describeGeofenceCollectionRequest- AConsumerthat will call methods onDescribeGeofenceCollectionRequest.Builderto create a request.- Returns:
- Result of the DescribeGeofenceCollection operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeKey
default DescribeKeyResponse describeKey(DescribeKeyRequest describeKeyRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the API key resource details.
- Parameters:
describeKeyRequest-- Returns:
- Result of the DescribeKey operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeKey
default DescribeKeyResponse describeKey(Consumer<DescribeKeyRequest.Builder> describeKeyRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the API key resource details.
This is a convenience which creates an instance of the
DescribeKeyRequest.Builderavoiding the need to create one manually viaDescribeKeyRequest.builder()- Parameters:
describeKeyRequest- AConsumerthat will call methods onDescribeKeyRequest.Builderto create a request.- Returns:
- Result of the DescribeKey operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeMap
default DescribeMapResponse describeMap(DescribeMapRequest describeMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the map resource details.
- Parameters:
describeMapRequest-- Returns:
- Result of the DescribeMap operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeMap
default DescribeMapResponse describeMap(Consumer<DescribeMapRequest.Builder> describeMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the map resource details.
This is a convenience which creates an instance of the
DescribeMapRequest.Builderavoiding the need to create one manually viaDescribeMapRequest.builder()- Parameters:
describeMapRequest- AConsumerthat will call methods onDescribeMapRequest.Builderto create a request.- Returns:
- Result of the DescribeMap operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describePlaceIndex
default DescribePlaceIndexResponse describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the place index resource details.
- Parameters:
describePlaceIndexRequest-- Returns:
- Result of the DescribePlaceIndex operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describePlaceIndex
default DescribePlaceIndexResponse describePlaceIndex(Consumer<DescribePlaceIndexRequest.Builder> describePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the place index resource details.
This is a convenience which creates an instance of the
DescribePlaceIndexRequest.Builderavoiding the need to create one manually viaDescribePlaceIndexRequest.builder()- Parameters:
describePlaceIndexRequest- AConsumerthat will call methods onDescribePlaceIndexRequest.Builderto create a request.- Returns:
- Result of the DescribePlaceIndex operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRouteCalculator
default DescribeRouteCalculatorResponse describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the route calculator resource details.
- Parameters:
describeRouteCalculatorRequest-- Returns:
- Result of the DescribeRouteCalculator operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRouteCalculator
default DescribeRouteCalculatorResponse describeRouteCalculator(Consumer<DescribeRouteCalculatorRequest.Builder> describeRouteCalculatorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the route calculator resource details.
This is a convenience which creates an instance of the
DescribeRouteCalculatorRequest.Builderavoiding the need to create one manually viaDescribeRouteCalculatorRequest.builder()- Parameters:
describeRouteCalculatorRequest- AConsumerthat will call methods onDescribeRouteCalculatorRequest.Builderto create a request.- Returns:
- Result of the DescribeRouteCalculator operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTracker
default DescribeTrackerResponse describeTracker(DescribeTrackerRequest describeTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the tracker resource details.
- Parameters:
describeTrackerRequest-- Returns:
- Result of the DescribeTracker operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTracker
default DescribeTrackerResponse describeTracker(Consumer<DescribeTrackerRequest.Builder> describeTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the tracker resource details.
This is a convenience which creates an instance of the
DescribeTrackerRequest.Builderavoiding the need to create one manually viaDescribeTrackerRequest.builder()- Parameters:
describeTrackerRequest- AConsumerthat will call methods onDescribeTrackerRequest.Builderto create a request.- Returns:
- Result of the DescribeTracker operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateTrackerConsumer
default DisassociateTrackerConsumerResponse disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Removes the association between a tracker resource and a geofence collection.
Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
- Parameters:
disassociateTrackerConsumerRequest-- Returns:
- Result of the DisassociateTrackerConsumer operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateTrackerConsumer
default DisassociateTrackerConsumerResponse disassociateTrackerConsumer(Consumer<DisassociateTrackerConsumerRequest.Builder> disassociateTrackerConsumerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaDisassociateTrackerConsumerRequest.builder()- Parameters:
disassociateTrackerConsumerRequest- AConsumerthat will call methods onDisassociateTrackerConsumerRequest.Builderto create a request.- Returns:
- Result of the DisassociateTrackerConsumer operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDevicePosition
default GetDevicePositionResponse getDevicePosition(GetDevicePositionRequest getDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
- Parameters:
getDevicePositionRequest-- Returns:
- Result of the GetDevicePosition operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDevicePosition
default GetDevicePositionResponse getDevicePosition(Consumer<GetDevicePositionRequest.Builder> getDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaGetDevicePositionRequest.builder()- Parameters:
getDevicePositionRequest- AConsumerthat will call methods onGetDevicePositionRequest.Builderto create a request.- Returns:
- Result of the GetDevicePosition operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDevicePositionHistory
default GetDevicePositionHistoryResponse getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
- Parameters:
getDevicePositionHistoryRequest-- Returns:
- Result of the GetDevicePositionHistory operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDevicePositionHistory
default GetDevicePositionHistoryResponse getDevicePositionHistory(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaGetDevicePositionHistoryRequest.builder()- Parameters:
getDevicePositionHistoryRequest- AConsumerthat will call methods onGetDevicePositionHistoryRequest.Builderto create a request.- Returns:
- Result of the GetDevicePositionHistory operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDevicePositionHistoryPaginator
default GetDevicePositionHistoryIterable getDevicePositionHistoryPaginator(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client.getDevicePositionHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client .getDevicePositionHistoryPaginator(request); for (software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client.getDevicePositionHistoryPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDevicePositionHistoryPaginator
default GetDevicePositionHistoryIterable getDevicePositionHistoryPaginator(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client.getDevicePositionHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client .getDevicePositionHistoryPaginator(request); for (software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client.getDevicePositionHistoryPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetDevicePositionHistoryRequest.builder()- Parameters:
getDevicePositionHistoryRequest- AConsumerthat will call methods onGetDevicePositionHistoryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getGeofence
default GetGeofenceResponse getGeofence(GetGeofenceRequest getGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the geofence details from a geofence collection.
- Parameters:
getGeofenceRequest-- Returns:
- Result of the GetGeofence operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getGeofence
default GetGeofenceResponse getGeofence(Consumer<GetGeofenceRequest.Builder> getGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the geofence details from a geofence collection.
This is a convenience which creates an instance of the
GetGeofenceRequest.Builderavoiding the need to create one manually viaGetGeofenceRequest.builder()- Parameters:
getGeofenceRequest- AConsumerthat will call methods onGetGeofenceRequest.Builderto create a request.- Returns:
- Result of the GetGeofence operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getMapGlyphs
default GetMapGlyphsResponse getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves glyphs used to display labels on a map.
- Parameters:
getMapGlyphsRequest-- Returns:
- Result of the GetMapGlyphs operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getMapGlyphs
default GetMapGlyphsResponse getMapGlyphs(Consumer<GetMapGlyphsRequest.Builder> getMapGlyphsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves glyphs used to display labels on a map.
This is a convenience which creates an instance of the
GetMapGlyphsRequest.Builderavoiding the need to create one manually viaGetMapGlyphsRequest.builder()- Parameters:
getMapGlyphsRequest- AConsumerthat will call methods onGetMapGlyphsRequest.Builderto create a request.- Returns:
- Result of the GetMapGlyphs operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getMapSprites
default GetMapSpritesResponse getMapSprites(GetMapSpritesRequest getMapSpritesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
- Parameters:
getMapSpritesRequest-- Returns:
- Result of the GetMapSprites operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getMapSprites
default GetMapSpritesResponse getMapSprites(Consumer<GetMapSpritesRequest.Builder> getMapSpritesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaGetMapSpritesRequest.builder()- Parameters:
getMapSpritesRequest- AConsumerthat will call methods onGetMapSpritesRequest.Builderto create a request.- Returns:
- Result of the GetMapSprites operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getMapStyleDescriptor
default GetMapStyleDescriptorResponse getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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:
- Result of the GetMapStyleDescriptor operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getMapStyleDescriptor
default GetMapStyleDescriptorResponse getMapStyleDescriptor(Consumer<GetMapStyleDescriptorRequest.Builder> getMapStyleDescriptorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaGetMapStyleDescriptorRequest.builder()- Parameters:
getMapStyleDescriptorRequest- AConsumerthat will call methods onGetMapStyleDescriptorRequest.Builderto create a request.- Returns:
- Result of the GetMapStyleDescriptor operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getMapTile
default GetMapTileResponse getMapTile(GetMapTileRequest getMapTileRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
- Parameters:
getMapTileRequest-- Returns:
- Result of the GetMapTile operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getMapTile
default GetMapTileResponse getMapTile(Consumer<GetMapTileRequest.Builder> getMapTileRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaGetMapTileRequest.builder()- Parameters:
getMapTileRequest- AConsumerthat will call methods onGetMapTileRequest.Builderto create a request.- Returns:
- Result of the GetMapTile operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
getPlace
default GetPlaceResponse getPlace(GetPlaceRequest getPlaceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Finds a place by its unique ID. A
PlaceIdis returned by other search operations.A PlaceId is valid only if all of the following are the same in the original search request and the call to
GetPlace.-
Customer Amazon Web Services account
-
Amazon Web Services Region
-
Data provider specified in the place index resource
- Parameters:
getPlaceRequest-- Returns:
- Result of the GetPlace operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getPlace
default GetPlaceResponse getPlace(Consumer<GetPlaceRequest.Builder> getPlaceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Finds a place by its unique ID. A
PlaceIdis 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.Builderavoiding the need to create one manually viaGetPlaceRequest.builder()- Parameters:
getPlaceRequest- AConsumerthat will call methods onGetPlaceRequest.Builderto create a request.- Returns:
- Result of the GetPlace operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
listDevicePositions
default ListDevicePositionsResponse listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
A batch request to retrieve all device positions.
- Parameters:
listDevicePositionsRequest-- Returns:
- Result of the ListDevicePositions operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDevicePositions
default ListDevicePositionsResponse listDevicePositions(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
A batch request to retrieve all device positions.
This is a convenience which creates an instance of the
ListDevicePositionsRequest.Builderavoiding the need to create one manually viaListDevicePositionsRequest.builder()- Parameters:
listDevicePositionsRequest- AConsumerthat will call methods onListDevicePositionsRequest.Builderto create a request.- Returns:
- Result of the ListDevicePositions operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDevicePositionsPaginator
default ListDevicePositionsIterable listDevicePositionsPaginator(ListDevicePositionsRequest listDevicePositionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable responses = client.listDevicePositionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable responses = client .listDevicePositionsPaginator(request); for (software.amazon.awssdk.services.location.model.ListDevicePositionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable responses = client.listDevicePositionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDevicePositionsPaginator
default ListDevicePositionsIterable listDevicePositionsPaginator(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable responses = client.listDevicePositionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable responses = client .listDevicePositionsPaginator(request); for (software.amazon.awssdk.services.location.model.ListDevicePositionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable responses = client.listDevicePositionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDevicePositionsRequest.builder()- Parameters:
listDevicePositionsRequest- AConsumerthat will call methods onListDevicePositionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listGeofenceCollections
default ListGeofenceCollectionsResponse listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections in your Amazon Web Services account.
- Parameters:
listGeofenceCollectionsRequest-- Returns:
- Result of the ListGeofenceCollections operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listGeofenceCollections
default ListGeofenceCollectionsResponse listGeofenceCollections(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListGeofenceCollectionsRequest.Builderavoiding the need to create one manually viaListGeofenceCollectionsRequest.builder()- Parameters:
listGeofenceCollectionsRequest- AConsumerthat will call methods onListGeofenceCollectionsRequest.Builderto create a request.- Returns:
- Result of the ListGeofenceCollections operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listGeofenceCollectionsPaginator
default ListGeofenceCollectionsIterable listGeofenceCollectionsPaginator(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable responses = client.listGeofenceCollectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable responses = client .listGeofenceCollectionsPaginator(request); for (software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable responses = client.listGeofenceCollectionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listGeofenceCollectionsPaginator
default ListGeofenceCollectionsIterable listGeofenceCollectionsPaginator(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable responses = client.listGeofenceCollectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable responses = client .listGeofenceCollectionsPaginator(request); for (software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable responses = client.listGeofenceCollectionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListGeofenceCollectionsRequest.builder()- Parameters:
listGeofenceCollectionsRequest- AConsumerthat will call methods onListGeofenceCollectionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listGeofences
default ListGeofencesResponse listGeofences(ListGeofencesRequest listGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofences stored in a given geofence collection.
- Parameters:
listGeofencesRequest-- Returns:
- Result of the ListGeofences operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listGeofences
default ListGeofencesResponse listGeofences(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofences stored in a given geofence collection.
This is a convenience which creates an instance of the
ListGeofencesRequest.Builderavoiding the need to create one manually viaListGeofencesRequest.builder()- Parameters:
listGeofencesRequest- AConsumerthat will call methods onListGeofencesRequest.Builderto create a request.- Returns:
- Result of the ListGeofences operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listGeofencesPaginator
default ListGeofencesIterable listGeofencesPaginator(ListGeofencesRequest listGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request); for (software.amazon.awssdk.services.location.model.ListGeofencesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listGeofencesPaginator
default ListGeofencesIterable listGeofencesPaginator(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request); for (software.amazon.awssdk.services.location.model.ListGeofencesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListGeofencesRequest.builder()- Parameters:
listGeofencesRequest- AConsumerthat will call methods onListGeofencesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listKeys
default ListKeysResponse listKeys(ListKeysRequest listKeysRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists API key resources in your Amazon Web Services account.
- Parameters:
listKeysRequest-- Returns:
- Result of the ListKeys operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listKeys
default ListKeysResponse listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists API key resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListKeysRequest.Builderavoiding the need to create one manually viaListKeysRequest.builder()- Parameters:
listKeysRequest- AConsumerthat will call methods onListKeysRequest.Builderto create a request.- Returns:
- Result of the ListKeys operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listKeysPaginator
default ListKeysIterable listKeysPaginator(ListKeysRequest listKeysRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListKeysIterable responses = client.listKeysPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListKeysIterable responses = client.listKeysPaginator(request); for (software.amazon.awssdk.services.location.model.ListKeysResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListKeysIterable responses = client.listKeysPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listKeysPaginator
default ListKeysIterable listKeysPaginator(Consumer<ListKeysRequest.Builder> listKeysRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListKeysIterable responses = client.listKeysPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListKeysIterable responses = client.listKeysPaginator(request); for (software.amazon.awssdk.services.location.model.ListKeysResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListKeysIterable responses = client.listKeysPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListKeysRequest.builder()- Parameters:
listKeysRequest- AConsumerthat will call methods onListKeysRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listMaps
default ListMapsResponse listMaps(ListMapsRequest listMapsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists map resources in your Amazon Web Services account.
- Parameters:
listMapsRequest-- Returns:
- Result of the ListMaps operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listMaps
default ListMapsResponse listMaps(Consumer<ListMapsRequest.Builder> listMapsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists map resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListMapsRequest.Builderavoiding the need to create one manually viaListMapsRequest.builder()- Parameters:
listMapsRequest- AConsumerthat will call methods onListMapsRequest.Builderto create a request.- Returns:
- Result of the ListMaps operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listMapsPaginator
default ListMapsIterable listMapsPaginator(ListMapsRequest listMapsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListMapsIterable responses = client.listMapsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListMapsIterable responses = client.listMapsPaginator(request); for (software.amazon.awssdk.services.location.model.ListMapsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListMapsIterable responses = client.listMapsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listMapsPaginator
default ListMapsIterable listMapsPaginator(Consumer<ListMapsRequest.Builder> listMapsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListMapsIterable responses = client.listMapsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListMapsIterable responses = client.listMapsPaginator(request); for (software.amazon.awssdk.services.location.model.ListMapsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListMapsIterable responses = client.listMapsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListMapsRequest.builder()- Parameters:
listMapsRequest- AConsumerthat will call methods onListMapsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listPlaceIndexes
default ListPlaceIndexesResponse listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists place index resources in your Amazon Web Services account.
- Parameters:
listPlaceIndexesRequest-- Returns:
- Result of the ListPlaceIndexes operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listPlaceIndexes
default ListPlaceIndexesResponse listPlaceIndexes(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists place index resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListPlaceIndexesRequest.Builderavoiding the need to create one manually viaListPlaceIndexesRequest.builder()- Parameters:
listPlaceIndexesRequest- AConsumerthat will call methods onListPlaceIndexesRequest.Builderto create a request.- Returns:
- Result of the ListPlaceIndexes operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listPlaceIndexesPaginator
default ListPlaceIndexesIterable listPlaceIndexesPaginator(ListPlaceIndexesRequest listPlaceIndexesRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable responses = client.listPlaceIndexesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable responses = client .listPlaceIndexesPaginator(request); for (software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable responses = client.listPlaceIndexesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listPlaceIndexesPaginator
default ListPlaceIndexesIterable listPlaceIndexesPaginator(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable responses = client.listPlaceIndexesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable responses = client .listPlaceIndexesPaginator(request); for (software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable responses = client.listPlaceIndexesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPlaceIndexesRequest.builder()- Parameters:
listPlaceIndexesRequest- AConsumerthat will call methods onListPlaceIndexesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listRouteCalculators
default ListRouteCalculatorsResponse listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists route calculator resources in your Amazon Web Services account.
- Parameters:
listRouteCalculatorsRequest-- Returns:
- Result of the ListRouteCalculators operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listRouteCalculators
default ListRouteCalculatorsResponse listRouteCalculators(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists route calculator resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListRouteCalculatorsRequest.Builderavoiding the need to create one manually viaListRouteCalculatorsRequest.builder()- Parameters:
listRouteCalculatorsRequest- AConsumerthat will call methods onListRouteCalculatorsRequest.Builderto create a request.- Returns:
- Result of the ListRouteCalculators operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listRouteCalculatorsPaginator
default ListRouteCalculatorsIterable listRouteCalculatorsPaginator(ListRouteCalculatorsRequest listRouteCalculatorsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable responses = client.listRouteCalculatorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable responses = client .listRouteCalculatorsPaginator(request); for (software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable responses = client.listRouteCalculatorsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listRouteCalculatorsPaginator
default ListRouteCalculatorsIterable listRouteCalculatorsPaginator(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable responses = client.listRouteCalculatorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable responses = client .listRouteCalculatorsPaginator(request); for (software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable responses = client.listRouteCalculatorsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListRouteCalculatorsRequest.builder()- Parameters:
listRouteCalculatorsRequest- AConsumerthat will call methods onListRouteCalculatorsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Returns a list of tags that are applied to the specified Amazon Location resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTrackerConsumers
default ListTrackerConsumersResponse listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections currently associated to the given tracker resource.
- Parameters:
listTrackerConsumersRequest-- Returns:
- Result of the ListTrackerConsumers operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTrackerConsumers
default ListTrackerConsumersResponse listTrackerConsumers(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections currently associated to the given tracker resource.
This is a convenience which creates an instance of the
ListTrackerConsumersRequest.Builderavoiding the need to create one manually viaListTrackerConsumersRequest.builder()- Parameters:
listTrackerConsumersRequest- AConsumerthat will call methods onListTrackerConsumersRequest.Builderto create a request.- Returns:
- Result of the ListTrackerConsumers operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTrackerConsumersPaginator
default ListTrackerConsumersIterable listTrackerConsumersPaginator(ListTrackerConsumersRequest listTrackerConsumersRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable responses = client.listTrackerConsumersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable responses = client .listTrackerConsumersPaginator(request); for (software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable responses = client.listTrackerConsumersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTrackerConsumersPaginator
default ListTrackerConsumersIterable listTrackerConsumersPaginator(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable responses = client.listTrackerConsumersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable responses = client .listTrackerConsumersPaginator(request); for (software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable responses = client.listTrackerConsumersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTrackerConsumersRequest.builder()- Parameters:
listTrackerConsumersRequest- AConsumerthat will call methods onListTrackerConsumersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTrackers
default ListTrackersResponse listTrackers(ListTrackersRequest listTrackersRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists tracker resources in your Amazon Web Services account.
- Parameters:
listTrackersRequest-- Returns:
- Result of the ListTrackers operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTrackers
default ListTrackersResponse listTrackers(Consumer<ListTrackersRequest.Builder> listTrackersRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists tracker resources in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListTrackersRequest.Builderavoiding the need to create one manually viaListTrackersRequest.builder()- Parameters:
listTrackersRequest- AConsumerthat will call methods onListTrackersRequest.Builderto create a request.- Returns:
- Result of the ListTrackers operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTrackersPaginator
default ListTrackersIterable listTrackersPaginator(ListTrackersRequest listTrackersRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListTrackersIterable responses = client.listTrackersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListTrackersIterable responses = client.listTrackersPaginator(request); for (software.amazon.awssdk.services.location.model.ListTrackersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListTrackersIterable responses = client.listTrackersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTrackersPaginator
default ListTrackersIterable listTrackersPaginator(Consumer<ListTrackersRequest.Builder> listTrackersRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
This is a variant of
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.location.paginators.ListTrackersIterable responses = client.listTrackersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.location.paginators.ListTrackersIterable responses = client.listTrackersPaginator(request); for (software.amazon.awssdk.services.location.model.ListTrackersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.location.paginators.ListTrackersIterable responses = client.listTrackersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTrackersRequest.builder()- Parameters:
listTrackersRequest- AConsumerthat will call methods onListTrackersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
putGeofence
default PutGeofenceResponse putGeofence(PutGeofenceRequest putGeofenceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
- Parameters:
putGeofenceRequest-- Returns:
- Result of the PutGeofence operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
putGeofence
default PutGeofenceResponse putGeofence(Consumer<PutGeofenceRequest.Builder> putGeofenceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaPutGeofenceRequest.builder()- Parameters:
putGeofenceRequest- AConsumerthat will call methods onPutGeofenceRequest.Builderto create a request.- Returns:
- Result of the PutGeofence operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.ConflictException- The request was unsuccessful because of a conflict.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
searchPlaceIndexForPosition
default SearchPlaceIndexForPositionResponse searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
- Parameters:
searchPlaceIndexForPositionRequest-- Returns:
- Result of the SearchPlaceIndexForPosition operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
searchPlaceIndexForPosition
default SearchPlaceIndexForPositionResponse searchPlaceIndexForPosition(Consumer<SearchPlaceIndexForPositionRequest.Builder> searchPlaceIndexForPositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaSearchPlaceIndexForPositionRequest.builder()- Parameters:
searchPlaceIndexForPositionRequest- AConsumerthat will call methods onSearchPlaceIndexForPositionRequest.Builderto create a request.- Returns:
- Result of the SearchPlaceIndexForPosition operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
searchPlaceIndexForSuggestions
default SearchPlaceIndexForSuggestionsResponse searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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 bothBiasPositionandFilterBBoxin the same command returns an error.- Parameters:
searchPlaceIndexForSuggestionsRequest-- Returns:
- Result of the SearchPlaceIndexForSuggestions operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
searchPlaceIndexForSuggestions
default SearchPlaceIndexForSuggestionsResponse searchPlaceIndexForSuggestions(Consumer<SearchPlaceIndexForSuggestionsRequest.Builder> searchPlaceIndexForSuggestionsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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 bothBiasPositionandFilterBBoxin the same command returns an error.
This is a convenience which creates an instance of the
SearchPlaceIndexForSuggestionsRequest.Builderavoiding the need to create one manually viaSearchPlaceIndexForSuggestionsRequest.builder()- Parameters:
searchPlaceIndexForSuggestionsRequest- AConsumerthat will call methods onSearchPlaceIndexForSuggestionsRequest.Builderto create a request.- Returns:
- Result of the SearchPlaceIndexForSuggestions operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
searchPlaceIndexForText
default SearchPlaceIndexForTextResponse searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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:
- Result of the SearchPlaceIndexForText operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
searchPlaceIndexForText
default SearchPlaceIndexForTextResponse searchPlaceIndexForText(Consumer<SearchPlaceIndexForTextRequest.Builder> searchPlaceIndexForTextRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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.Builderavoiding the need to create one manually viaSearchPlaceIndexForTextRequest.builder()- Parameters:
searchPlaceIndexForTextRequest- AConsumerthat will call methods onSearchPlaceIndexForTextRequest.Builderto create a request.- Returns:
- Result of the SearchPlaceIndexForText operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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
TagResourceoperation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate up to 50 tags with a resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
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
TagResourceoperation 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Removes one or more tags from the specified Amazon Location resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Removes one or more tags from the specified Amazon Location resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGeofenceCollection
default UpdateGeofenceCollectionResponse updateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given geofence collection.
- Parameters:
updateGeofenceCollectionRequest-- Returns:
- Result of the UpdateGeofenceCollection operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGeofenceCollection
default UpdateGeofenceCollectionResponse updateGeofenceCollection(Consumer<UpdateGeofenceCollectionRequest.Builder> updateGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given geofence collection.
This is a convenience which creates an instance of the
UpdateGeofenceCollectionRequest.Builderavoiding the need to create one manually viaUpdateGeofenceCollectionRequest.builder()- Parameters:
updateGeofenceCollectionRequest- AConsumerthat will call methods onUpdateGeofenceCollectionRequest.Builderto create a request.- Returns:
- Result of the UpdateGeofenceCollection operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateKey
default UpdateKeyResponse updateKey(UpdateKeyRequest updateKeyRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given API key resource.
- Parameters:
updateKeyRequest-- Returns:
- Result of the UpdateKey operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateKey
default UpdateKeyResponse updateKey(Consumer<UpdateKeyRequest.Builder> updateKeyRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given API key resource.
This is a convenience which creates an instance of the
UpdateKeyRequest.Builderavoiding the need to create one manually viaUpdateKeyRequest.builder()- Parameters:
updateKeyRequest- AConsumerthat will call methods onUpdateKeyRequest.Builderto create a request.- Returns:
- Result of the UpdateKey operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateMap
default UpdateMapResponse updateMap(UpdateMapRequest updateMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given map resource.
- Parameters:
updateMapRequest-- Returns:
- Result of the UpdateMap operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateMap
default UpdateMapResponse updateMap(Consumer<UpdateMapRequest.Builder> updateMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given map resource.
This is a convenience which creates an instance of the
UpdateMapRequest.Builderavoiding the need to create one manually viaUpdateMapRequest.builder()- Parameters:
updateMapRequest- AConsumerthat will call methods onUpdateMapRequest.Builderto create a request.- Returns:
- Result of the UpdateMap operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePlaceIndex
default UpdatePlaceIndexResponse updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given place index resource.
- Parameters:
updatePlaceIndexRequest-- Returns:
- Result of the UpdatePlaceIndex operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePlaceIndex
default UpdatePlaceIndexResponse updatePlaceIndex(Consumer<UpdatePlaceIndexRequest.Builder> updatePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given place index resource.
This is a convenience which creates an instance of the
UpdatePlaceIndexRequest.Builderavoiding the need to create one manually viaUpdatePlaceIndexRequest.builder()- Parameters:
updatePlaceIndexRequest- AConsumerthat will call methods onUpdatePlaceIndexRequest.Builderto create a request.- Returns:
- Result of the UpdatePlaceIndex operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateRouteCalculator
default UpdateRouteCalculatorResponse updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties for a given route calculator resource.
- Parameters:
updateRouteCalculatorRequest-- Returns:
- Result of the UpdateRouteCalculator operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateRouteCalculator
default UpdateRouteCalculatorResponse updateRouteCalculator(Consumer<UpdateRouteCalculatorRequest.Builder> updateRouteCalculatorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties for a given route calculator resource.
This is a convenience which creates an instance of the
UpdateRouteCalculatorRequest.Builderavoiding the need to create one manually viaUpdateRouteCalculatorRequest.builder()- Parameters:
updateRouteCalculatorRequest- AConsumerthat will call methods onUpdateRouteCalculatorRequest.Builderto create a request.- Returns:
- Result of the UpdateRouteCalculator operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTracker
default UpdateTrackerResponse updateTracker(UpdateTrackerRequest updateTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given tracker resource.
- Parameters:
updateTrackerRequest-- Returns:
- Result of the UpdateTracker operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTracker
default UpdateTrackerResponse updateTracker(Consumer<UpdateTrackerRequest.Builder> updateTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Updates the specified properties of a given tracker resource.
This is a convenience which creates an instance of the
UpdateTrackerRequest.Builderavoiding the need to create one manually viaUpdateTrackerRequest.builder()- Parameters:
updateTrackerRequest- AConsumerthat will call methods onUpdateTrackerRequest.Builderto create a request.- Returns:
- Result of the UpdateTracker operation returned by the service.
- Throws:
InternalServerException- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException- The resource that you've entered was not found in your AWS account.AccessDeniedException- The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.ValidationException- The input failed to meet the constraints specified by the AWS service.ThrottlingException- The request was denied because of request throttling.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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static LocationClient create()
Create aLocationClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static LocationClientBuilder builder()
Create a builder that can be used to configure and create aLocationClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default LocationServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-