software.amazon.awssdk.services.location.LocationClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.location;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.location.model.AccessDeniedException;
import software.amazon.awssdk.services.location.model.AssociateTrackerConsumerRequest;
import software.amazon.awssdk.services.location.model.AssociateTrackerConsumerResponse;
import software.amazon.awssdk.services.location.model.BatchDeleteDevicePositionHistoryRequest;
import software.amazon.awssdk.services.location.model.BatchDeleteDevicePositionHistoryResponse;
import software.amazon.awssdk.services.location.model.BatchDeleteGeofenceRequest;
import software.amazon.awssdk.services.location.model.BatchDeleteGeofenceResponse;
import software.amazon.awssdk.services.location.model.BatchEvaluateGeofencesRequest;
import software.amazon.awssdk.services.location.model.BatchEvaluateGeofencesResponse;
import software.amazon.awssdk.services.location.model.BatchGetDevicePositionRequest;
import software.amazon.awssdk.services.location.model.BatchGetDevicePositionResponse;
import software.amazon.awssdk.services.location.model.BatchPutGeofenceRequest;
import software.amazon.awssdk.services.location.model.BatchPutGeofenceResponse;
import software.amazon.awssdk.services.location.model.BatchUpdateDevicePositionRequest;
import software.amazon.awssdk.services.location.model.BatchUpdateDevicePositionResponse;
import software.amazon.awssdk.services.location.model.CalculateRouteMatrixRequest;
import software.amazon.awssdk.services.location.model.CalculateRouteMatrixResponse;
import software.amazon.awssdk.services.location.model.CalculateRouteRequest;
import software.amazon.awssdk.services.location.model.CalculateRouteResponse;
import software.amazon.awssdk.services.location.model.ConflictException;
import software.amazon.awssdk.services.location.model.CreateGeofenceCollectionRequest;
import software.amazon.awssdk.services.location.model.CreateGeofenceCollectionResponse;
import software.amazon.awssdk.services.location.model.CreateKeyRequest;
import software.amazon.awssdk.services.location.model.CreateKeyResponse;
import software.amazon.awssdk.services.location.model.CreateMapRequest;
import software.amazon.awssdk.services.location.model.CreateMapResponse;
import software.amazon.awssdk.services.location.model.CreatePlaceIndexRequest;
import software.amazon.awssdk.services.location.model.CreatePlaceIndexResponse;
import software.amazon.awssdk.services.location.model.CreateRouteCalculatorRequest;
import software.amazon.awssdk.services.location.model.CreateRouteCalculatorResponse;
import software.amazon.awssdk.services.location.model.CreateTrackerRequest;
import software.amazon.awssdk.services.location.model.CreateTrackerResponse;
import software.amazon.awssdk.services.location.model.DeleteGeofenceCollectionRequest;
import software.amazon.awssdk.services.location.model.DeleteGeofenceCollectionResponse;
import software.amazon.awssdk.services.location.model.DeleteKeyRequest;
import software.amazon.awssdk.services.location.model.DeleteKeyResponse;
import software.amazon.awssdk.services.location.model.DeleteMapRequest;
import software.amazon.awssdk.services.location.model.DeleteMapResponse;
import software.amazon.awssdk.services.location.model.DeletePlaceIndexRequest;
import software.amazon.awssdk.services.location.model.DeletePlaceIndexResponse;
import software.amazon.awssdk.services.location.model.DeleteRouteCalculatorRequest;
import software.amazon.awssdk.services.location.model.DeleteRouteCalculatorResponse;
import software.amazon.awssdk.services.location.model.DeleteTrackerRequest;
import software.amazon.awssdk.services.location.model.DeleteTrackerResponse;
import software.amazon.awssdk.services.location.model.DescribeGeofenceCollectionRequest;
import software.amazon.awssdk.services.location.model.DescribeGeofenceCollectionResponse;
import software.amazon.awssdk.services.location.model.DescribeKeyRequest;
import software.amazon.awssdk.services.location.model.DescribeKeyResponse;
import software.amazon.awssdk.services.location.model.DescribeMapRequest;
import software.amazon.awssdk.services.location.model.DescribeMapResponse;
import software.amazon.awssdk.services.location.model.DescribePlaceIndexRequest;
import software.amazon.awssdk.services.location.model.DescribePlaceIndexResponse;
import software.amazon.awssdk.services.location.model.DescribeRouteCalculatorRequest;
import software.amazon.awssdk.services.location.model.DescribeRouteCalculatorResponse;
import software.amazon.awssdk.services.location.model.DescribeTrackerRequest;
import software.amazon.awssdk.services.location.model.DescribeTrackerResponse;
import software.amazon.awssdk.services.location.model.DisassociateTrackerConsumerRequest;
import software.amazon.awssdk.services.location.model.DisassociateTrackerConsumerResponse;
import software.amazon.awssdk.services.location.model.ForecastGeofenceEventsRequest;
import software.amazon.awssdk.services.location.model.ForecastGeofenceEventsResponse;
import software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest;
import software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse;
import software.amazon.awssdk.services.location.model.GetDevicePositionRequest;
import software.amazon.awssdk.services.location.model.GetDevicePositionResponse;
import software.amazon.awssdk.services.location.model.GetGeofenceRequest;
import software.amazon.awssdk.services.location.model.GetGeofenceResponse;
import software.amazon.awssdk.services.location.model.GetMapGlyphsRequest;
import software.amazon.awssdk.services.location.model.GetMapGlyphsResponse;
import software.amazon.awssdk.services.location.model.GetMapSpritesRequest;
import software.amazon.awssdk.services.location.model.GetMapSpritesResponse;
import software.amazon.awssdk.services.location.model.GetMapStyleDescriptorRequest;
import software.amazon.awssdk.services.location.model.GetMapStyleDescriptorResponse;
import software.amazon.awssdk.services.location.model.GetMapTileRequest;
import software.amazon.awssdk.services.location.model.GetMapTileResponse;
import software.amazon.awssdk.services.location.model.GetPlaceRequest;
import software.amazon.awssdk.services.location.model.GetPlaceResponse;
import software.amazon.awssdk.services.location.model.InternalServerException;
import software.amazon.awssdk.services.location.model.ListDevicePositionsRequest;
import software.amazon.awssdk.services.location.model.ListDevicePositionsResponse;
import software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest;
import software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse;
import software.amazon.awssdk.services.location.model.ListGeofencesRequest;
import software.amazon.awssdk.services.location.model.ListGeofencesResponse;
import software.amazon.awssdk.services.location.model.ListKeysRequest;
import software.amazon.awssdk.services.location.model.ListKeysResponse;
import software.amazon.awssdk.services.location.model.ListMapsRequest;
import software.amazon.awssdk.services.location.model.ListMapsResponse;
import software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest;
import software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse;
import software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest;
import software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse;
import software.amazon.awssdk.services.location.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.location.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest;
import software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse;
import software.amazon.awssdk.services.location.model.ListTrackersRequest;
import software.amazon.awssdk.services.location.model.ListTrackersResponse;
import software.amazon.awssdk.services.location.model.LocationException;
import software.amazon.awssdk.services.location.model.PutGeofenceRequest;
import software.amazon.awssdk.services.location.model.PutGeofenceResponse;
import software.amazon.awssdk.services.location.model.ResourceNotFoundException;
import software.amazon.awssdk.services.location.model.SearchPlaceIndexForPositionRequest;
import software.amazon.awssdk.services.location.model.SearchPlaceIndexForPositionResponse;
import software.amazon.awssdk.services.location.model.SearchPlaceIndexForSuggestionsRequest;
import software.amazon.awssdk.services.location.model.SearchPlaceIndexForSuggestionsResponse;
import software.amazon.awssdk.services.location.model.SearchPlaceIndexForTextRequest;
import software.amazon.awssdk.services.location.model.SearchPlaceIndexForTextResponse;
import software.amazon.awssdk.services.location.model.ServiceQuotaExceededException;
import software.amazon.awssdk.services.location.model.TagResourceRequest;
import software.amazon.awssdk.services.location.model.TagResourceResponse;
import software.amazon.awssdk.services.location.model.ThrottlingException;
import software.amazon.awssdk.services.location.model.UntagResourceRequest;
import software.amazon.awssdk.services.location.model.UntagResourceResponse;
import software.amazon.awssdk.services.location.model.UpdateGeofenceCollectionRequest;
import software.amazon.awssdk.services.location.model.UpdateGeofenceCollectionResponse;
import software.amazon.awssdk.services.location.model.UpdateKeyRequest;
import software.amazon.awssdk.services.location.model.UpdateKeyResponse;
import software.amazon.awssdk.services.location.model.UpdateMapRequest;
import software.amazon.awssdk.services.location.model.UpdateMapResponse;
import software.amazon.awssdk.services.location.model.UpdatePlaceIndexRequest;
import software.amazon.awssdk.services.location.model.UpdatePlaceIndexResponse;
import software.amazon.awssdk.services.location.model.UpdateRouteCalculatorRequest;
import software.amazon.awssdk.services.location.model.UpdateRouteCalculatorResponse;
import software.amazon.awssdk.services.location.model.UpdateTrackerRequest;
import software.amazon.awssdk.services.location.model.UpdateTrackerResponse;
import software.amazon.awssdk.services.location.model.ValidationException;
import software.amazon.awssdk.services.location.model.VerifyDevicePositionRequest;
import software.amazon.awssdk.services.location.model.VerifyDevicePositionResponse;
import software.amazon.awssdk.services.location.paginators.ForecastGeofenceEventsIterable;
import software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable;
import software.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable;
import software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable;
import software.amazon.awssdk.services.location.paginators.ListGeofencesIterable;
import software.amazon.awssdk.services.location.paginators.ListKeysIterable;
import software.amazon.awssdk.services.location.paginators.ListMapsIterable;
import software.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable;
import software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable;
import software.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable;
import software.amazon.awssdk.services.location.paginators.ListTrackersIterable;
/**
* Service client for accessing Amazon Location Service. This can be created using the static {@link #builder()} method.
*
*
* "Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface LocationClient extends AwsClient {
String SERVICE_NAME = "geo";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "geo";
/**
*
* 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.
*
*
*
* @param associateTrackerConsumerRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.AssociateTrackerConsumer
* @see AWS API Documentation
*/
default AssociateTrackerConsumerResponse associateTrackerConsumer(
AssociateTrackerConsumerRequest associateTrackerConsumerRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException,
ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link AssociateTrackerConsumerRequest.Builder} avoiding
* the need to create one manually via {@link AssociateTrackerConsumerRequest#builder()}
*
*
* @param associateTrackerConsumerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.AssociateTrackerConsumerRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.AssociateTrackerConsumer
* @see AWS API Documentation
*/
default AssociateTrackerConsumerResponse associateTrackerConsumer(
Consumer associateTrackerConsumerRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException,
ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return associateTrackerConsumer(AssociateTrackerConsumerRequest.builder().applyMutation(associateTrackerConsumerRequest)
.build());
}
/**
*
* Deletes the position history of one or more devices from a tracker resource.
*
*
* @param batchDeleteDevicePositionHistoryRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchDeleteDevicePositionHistory
* @see AWS API Documentation
*/
default BatchDeleteDevicePositionHistoryResponse batchDeleteDevicePositionHistory(
BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the position history of one or more devices from a tracker resource.
*
*
*
* This is a convenience which creates an instance of the {@link BatchDeleteDevicePositionHistoryRequest.Builder}
* avoiding the need to create one manually via {@link BatchDeleteDevicePositionHistoryRequest#builder()}
*
*
* @param batchDeleteDevicePositionHistoryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.BatchDeleteDevicePositionHistoryRequest.Builder} to
* create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchDeleteDevicePositionHistory
* @see AWS API Documentation
*/
default BatchDeleteDevicePositionHistoryResponse batchDeleteDevicePositionHistory(
Consumer batchDeleteDevicePositionHistoryRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest.builder()
.applyMutation(batchDeleteDevicePositionHistoryRequest).build());
}
/**
*
* Deletes a batch of geofences from a geofence collection.
*
*
*
* This operation deletes the resource permanently.
*
*
*
* @param batchDeleteGeofenceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchDeleteGeofence
* @see AWS
* API Documentation
*/
default BatchDeleteGeofenceResponse batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchDeleteGeofenceRequest.Builder} avoiding the
* need to create one manually via {@link BatchDeleteGeofenceRequest#builder()}
*
*
* @param batchDeleteGeofenceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.BatchDeleteGeofenceRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchDeleteGeofence
* @see AWS
* API Documentation
*/
default BatchDeleteGeofenceResponse batchDeleteGeofence(
Consumer batchDeleteGeofenceRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return batchDeleteGeofence(BatchDeleteGeofenceRequest.builder().applyMutation(batchDeleteGeofenceRequest).build());
}
/**
*
* Evaluates device positions against the geofence geometries from a given geofence collection.
*
*
* This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation
* determines if the device has entered or exited a geofenced area, and then publishes one of the following events
* to Amazon EventBridge:
*
*
* -
*
* ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
*
*
* -
*
* EXIT if Amazon Location determines that the tracked device has exited a geofenced area.
*
*
*
*
*
* The last geofence that a device was observed within is tracked for 30 days after the most recent device position
* update.
*
*
*
* Geofence evaluation uses the given device position. It does not account for the optional Accuracy of
* a DevicePositionUpdate.
*
*
*
* The DeviceID is used as a string to represent the device. You do not need to have a
* Tracker associated with the DeviceID.
*
*
*
* @param batchEvaluateGeofencesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchEvaluateGeofences
* @see AWS API Documentation
*/
default BatchEvaluateGeofencesResponse batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Evaluates device positions against the geofence geometries from a given geofence collection.
*
*
* This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation
* determines if the device has entered or exited a geofenced area, and then publishes one of the following events
* to Amazon EventBridge:
*
*
* -
*
* ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
*
*
* -
*
* EXIT if Amazon Location determines that the tracked device has exited a geofenced area.
*
*
*
*
*
* The last geofence that a device was observed within is tracked for 30 days after the most recent device position
* update.
*
*
*
* Geofence evaluation uses the given device position. It does not account for the optional Accuracy of
* a DevicePositionUpdate.
*
*
*
* The DeviceID is used as a string to represent the device. You do not need to have a
* Tracker associated with the DeviceID.
*
*
*
* This is a convenience which creates an instance of the {@link BatchEvaluateGeofencesRequest.Builder} avoiding the
* need to create one manually via {@link BatchEvaluateGeofencesRequest#builder()}
*
*
* @param batchEvaluateGeofencesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.BatchEvaluateGeofencesRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchEvaluateGeofences
* @see AWS API Documentation
*/
default BatchEvaluateGeofencesResponse batchEvaluateGeofences(
Consumer batchEvaluateGeofencesRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return batchEvaluateGeofences(BatchEvaluateGeofencesRequest.builder().applyMutation(batchEvaluateGeofencesRequest)
.build());
}
/**
*
* Lists the latest device positions for requested devices.
*
*
* @param batchGetDevicePositionRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchGetDevicePosition
* @see AWS API Documentation
*/
default BatchGetDevicePositionResponse batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the latest device positions for requested devices.
*
*
*
* This is a convenience which creates an instance of the {@link BatchGetDevicePositionRequest.Builder} avoiding the
* need to create one manually via {@link BatchGetDevicePositionRequest#builder()}
*
*
* @param batchGetDevicePositionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.BatchGetDevicePositionRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchGetDevicePosition
* @see AWS API Documentation
*/
default BatchGetDevicePositionResponse batchGetDevicePosition(
Consumer batchGetDevicePositionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return batchGetDevicePosition(BatchGetDevicePositionRequest.builder().applyMutation(batchGetDevicePositionRequest)
.build());
}
/**
*
* 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.
*
*
* @param batchPutGeofenceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchPutGeofence
* @see AWS API
* Documentation
*/
default BatchPutGeofenceResponse batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchPutGeofenceRequest.Builder} avoiding the need
* to create one manually via {@link BatchPutGeofenceRequest#builder()}
*
*
* @param batchPutGeofenceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.BatchPutGeofenceRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchPutGeofence
* @see AWS API
* Documentation
*/
default BatchPutGeofenceResponse batchPutGeofence(Consumer batchPutGeofenceRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return batchPutGeofence(BatchPutGeofenceRequest.builder().applyMutation(batchPutGeofenceRequest).build());
}
/**
*
* Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). Amazon
* Location uses the data when it reports the last known device position and position history. Amazon Location
* retains location data for 30 days.
*
*
*
* Position updates are handled based on the PositionFiltering property of the tracker. When
* PositionFiltering is set to TimeBased, updates are evaluated against linked geofence
* collections, and location data is stored at a maximum of one position per 30 second interval. If your update
* frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device
* ID.
*
*
* When PositionFiltering is set to DistanceBased filtering, location data is stored and
* evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).
*
*
* When PositionFiltering is set to AccuracyBased filtering, location data is stored and
* evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For
* example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
* is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set
* to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0}
* when accuracy is not provided on a DevicePositionUpdate.
*
*
*
* @param batchUpdateDevicePositionRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchUpdateDevicePosition
* @see AWS API Documentation
*/
default BatchUpdateDevicePositionResponse batchUpdateDevicePosition(
BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). Amazon
* Location uses the data when it reports the last known device position and position history. Amazon Location
* retains location data for 30 days.
*
*
*
* Position updates are handled based on the PositionFiltering property of the tracker. When
* PositionFiltering is set to TimeBased, updates are evaluated against linked geofence
* collections, and location data is stored at a maximum of one position per 30 second interval. If your update
* frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device
* ID.
*
*
* When PositionFiltering is set to DistanceBased filtering, location data is stored and
* evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).
*
*
* When PositionFiltering is set to AccuracyBased filtering, location data is stored and
* evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For
* example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
* is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set
* to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0}
* when accuracy is not provided on a DevicePositionUpdate.
*
*
*
* This is a convenience which creates an instance of the {@link BatchUpdateDevicePositionRequest.Builder} avoiding
* the need to create one manually via {@link BatchUpdateDevicePositionRequest#builder()}
*
*
* @param batchUpdateDevicePositionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.BatchUpdateDevicePositionRequest.Builder} to create
* a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.BatchUpdateDevicePosition
* @see AWS API Documentation
*/
default BatchUpdateDevicePositionResponse batchUpdateDevicePosition(
Consumer batchUpdateDevicePositionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return batchUpdateDevicePosition(BatchUpdateDevicePositionRequest.builder()
.applyMutation(batchUpdateDevicePositionRequest).build());
}
/**
*
* Calculates a route
* given the following required parameters: DeparturePosition and DestinationPosition.
* Requires that you first create a
* route calculator resource.
*
*
* By default, a request that doesn't specify a departure time uses the best time of day to travel with the best
* traffic conditions when calculating the route.
*
*
* Additional options include:
*
*
* -
*
* Specifying a departure
* time using either DepartureTime or DepartNow. This calculates a route based on
* predictive traffic data at the given time.
*
*
*
* You can't specify both DepartureTime and DepartNow in a single request. Specifying both
* parameters returns a validation error.
*
*
* -
*
* Specifying a travel
* mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
* additional route preferences in CarModeOptions if traveling by Car, or
* TruckModeOptions if traveling by Truck.
*
*
*
* If you specify walking for the travel mode and your data provider is Esri, the start and destination
* must be within 40km.
*
*
*
*
* @param calculateRouteRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CalculateRoute
* @see AWS API
* Documentation
*/
default CalculateRouteResponse calculateRoute(CalculateRouteRequest calculateRouteRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Calculates a route
* given the following required parameters: DeparturePosition and DestinationPosition.
* Requires that you first create a
* route calculator resource.
*
*
* By default, a request that doesn't specify a departure time uses the best time of day to travel with the best
* traffic conditions when calculating the route.
*
*
* Additional options include:
*
*
* -
*
* Specifying a departure
* time using either DepartureTime or DepartNow. This calculates a route based on
* predictive traffic data at the given time.
*
*
*
* You can't specify both DepartureTime and DepartNow in a single request. Specifying both
* parameters returns a validation error.
*
*
* -
*
* Specifying a travel
* mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
* additional route preferences in CarModeOptions if traveling by Car, or
* TruckModeOptions if traveling by Truck.
*
*
*
* If you specify walking for the travel mode and your data provider is Esri, the start and destination
* must be within 40km.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CalculateRouteRequest.Builder} avoiding the need to
* create one manually via {@link CalculateRouteRequest#builder()}
*
*
* @param calculateRouteRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.CalculateRouteRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CalculateRoute
* @see AWS API
* Documentation
*/
default CalculateRouteResponse calculateRoute(Consumer calculateRouteRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return calculateRoute(CalculateRouteRequest.builder().applyMutation(calculateRouteRequest).build());
}
/**
*
* Calculates a
* route matrix given the following required parameters: DeparturePositions and
* DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel
* time and travel distance from each departure position to each destination position in the request. For example,
* given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will
* return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of
* results returned (and routes calculated) will be the number of DeparturePositions times the number
* of DestinationPositions.
*
*
*
* Your account is charged for each route calculated, not the number of requests.
*
*
*
* Requires that you first create a
* route calculator resource.
*
*
* By default, a request that doesn't specify a departure time uses the best time of day to travel with the best
* traffic conditions when calculating routes.
*
*
* Additional options include:
*
*
* -
*
* Specifying a departure
* time using either DepartureTime or DepartNow. This calculates routes based on
* predictive traffic data at the given time.
*
*
*
* You can't specify both DepartureTime and DepartNow in a single request. Specifying both
* parameters returns a validation error.
*
*
* -
*
* Specifying a travel
* mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
* additional route preferences in CarModeOptions if traveling by Car, or
* TruckModeOptions if traveling by Truck.
*
*
*
*
* @param calculateRouteMatrixRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CalculateRouteMatrix
* @see AWS
* API Documentation
*/
default CalculateRouteMatrixResponse calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Calculates a
* route matrix given the following required parameters: DeparturePositions and
* DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel
* time and travel distance from each departure position to each destination position in the request. For example,
* given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will
* return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of
* results returned (and routes calculated) will be the number of DeparturePositions times the number
* of DestinationPositions.
*
*
*
* Your account is charged for each route calculated, not the number of requests.
*
*
*
* Requires that you first create a
* route calculator resource.
*
*
* By default, a request that doesn't specify a departure time uses the best time of day to travel with the best
* traffic conditions when calculating routes.
*
*
* Additional options include:
*
*
* -
*
* Specifying a departure
* time using either DepartureTime or DepartNow. This calculates routes based on
* predictive traffic data at the given time.
*
*
*
* You can't specify both DepartureTime and DepartNow in a single request. Specifying both
* parameters returns a validation error.
*
*
* -
*
* Specifying a travel
* mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
* additional route preferences in CarModeOptions if traveling by Car, or
* TruckModeOptions if traveling by Truck.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CalculateRouteMatrixRequest.Builder} avoiding the
* need to create one manually via {@link CalculateRouteMatrixRequest#builder()}
*
*
* @param calculateRouteMatrixRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.CalculateRouteMatrixRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CalculateRouteMatrix
* @see AWS
* API Documentation
*/
default CalculateRouteMatrixResponse calculateRouteMatrix(
Consumer calculateRouteMatrixRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return calculateRouteMatrix(CalculateRouteMatrixRequest.builder().applyMutation(calculateRouteMatrixRequest).build());
}
/**
*
* Creates a geofence collection, which manages and stores geofences.
*
*
* @param createGeofenceCollectionRequest
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateGeofenceCollection
* @see AWS API Documentation
*/
default CreateGeofenceCollectionResponse createGeofenceCollection(
CreateGeofenceCollectionRequest createGeofenceCollectionRequest) throws InternalServerException, ConflictException,
AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a geofence collection, which manages and stores geofences.
*
*
*
* This is a convenience which creates an instance of the {@link CreateGeofenceCollectionRequest.Builder} avoiding
* the need to create one manually via {@link CreateGeofenceCollectionRequest#builder()}
*
*
* @param createGeofenceCollectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.CreateGeofenceCollectionRequest.Builder} to create a
* request.
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateGeofenceCollection
* @see AWS API Documentation
*/
default CreateGeofenceCollectionResponse createGeofenceCollection(
Consumer createGeofenceCollectionRequest) throws InternalServerException,
ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException,
AwsServiceException, SdkClientException, LocationException {
return createGeofenceCollection(CreateGeofenceCollectionRequest.builder().applyMutation(createGeofenceCollectionRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param createKeyRequest
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateKey
* @see AWS API
* Documentation
*/
default CreateKeyResponse createKey(CreateKeyRequest createKeyRequest) throws InternalServerException, ConflictException,
AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateKeyRequest.Builder} avoiding the need to
* create one manually via {@link CreateKeyRequest#builder()}
*
*
* @param createKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.CreateKeyRequest.Builder} to create a request.
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateKey
* @see AWS API
* Documentation
*/
default CreateKeyResponse createKey(Consumer createKeyRequest) throws InternalServerException,
ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException,
AwsServiceException, SdkClientException, LocationException {
return createKey(CreateKeyRequest.builder().applyMutation(createKeyRequest).build());
}
/**
*
* 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.
*
*
*
* @param createMapRequest
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateMap
* @see AWS API
* Documentation
*/
default CreateMapResponse createMap(CreateMapRequest createMapRequest) throws InternalServerException, ConflictException,
AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateMapRequest.Builder} avoiding the need to
* create one manually via {@link CreateMapRequest#builder()}
*
*
* @param createMapRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.CreateMapRequest.Builder} to create a request.
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateMap
* @see AWS API
* Documentation
*/
default CreateMapResponse createMap(Consumer createMapRequest) throws InternalServerException,
ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException,
AwsServiceException, SdkClientException, LocationException {
return createMap(CreateMapRequest.builder().applyMutation(createMapRequest).build());
}
/**
*
* Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode
* addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode
* coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using
* the SearchPlaceIndexForSuggestions operation.
*
*
*
* If your application is tracking or routing assets you use in your business, such as delivery vehicles or
* employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
*
*
*
* @param createPlaceIndexRequest
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreatePlaceIndex
* @see AWS API
* Documentation
*/
default CreatePlaceIndexResponse createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
throws InternalServerException, ConflictException, AccessDeniedException, ValidationException,
ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode
* addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode
* coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using
* the SearchPlaceIndexForSuggestions operation.
*
*
*
* If your application is tracking or routing assets you use in your business, such as delivery vehicles or
* employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
*
*
*
* This is a convenience which creates an instance of the {@link CreatePlaceIndexRequest.Builder} avoiding the need
* to create one manually via {@link CreatePlaceIndexRequest#builder()}
*
*
* @param createPlaceIndexRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.CreatePlaceIndexRequest.Builder} to create a
* request.
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreatePlaceIndex
* @see AWS API
* Documentation
*/
default CreatePlaceIndexResponse createPlaceIndex(Consumer createPlaceIndexRequest)
throws InternalServerException, ConflictException, AccessDeniedException, ValidationException,
ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return createPlaceIndex(CreatePlaceIndexRequest.builder().applyMutation(createPlaceIndexRequest).build());
}
/**
*
* 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.
*
*
*
* @param createRouteCalculatorRequest
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateRouteCalculator
* @see AWS API Documentation
*/
default CreateRouteCalculatorResponse createRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest)
throws InternalServerException, ConflictException, AccessDeniedException, ValidationException,
ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateRouteCalculatorRequest.Builder} avoiding the
* need to create one manually via {@link CreateRouteCalculatorRequest#builder()}
*
*
* @param createRouteCalculatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.CreateRouteCalculatorRequest.Builder} to create a
* request.
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateRouteCalculator
* @see AWS API Documentation
*/
default CreateRouteCalculatorResponse createRouteCalculator(
Consumer createRouteCalculatorRequest) throws InternalServerException,
ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException,
AwsServiceException, SdkClientException, LocationException {
return createRouteCalculator(CreateRouteCalculatorRequest.builder().applyMutation(createRouteCalculatorRequest).build());
}
/**
*
* Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical
* location of devices.
*
*
* @param createTrackerRequest
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateTracker
* @see AWS API
* Documentation
*/
default CreateTrackerResponse createTracker(CreateTrackerRequest createTrackerRequest) throws InternalServerException,
ConflictException, AccessDeniedException, ValidationException, ServiceQuotaExceededException, ThrottlingException,
AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateTrackerRequest.Builder} avoiding the need to
* create one manually via {@link CreateTrackerRequest#builder()}
*
*
* @param createTrackerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.CreateTrackerRequest.Builder} to create a request.
* @return 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.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ServiceQuotaExceededException
* The operation was denied because the request would exceed the maximum quota set for
* Amazon Location Service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.CreateTracker
* @see AWS API
* Documentation
*/
default CreateTrackerResponse createTracker(Consumer createTrackerRequest)
throws InternalServerException, ConflictException, AccessDeniedException, ValidationException,
ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return createTracker(CreateTrackerRequest.builder().applyMutation(createTrackerRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteGeofenceCollectionRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteGeofenceCollection
* @see AWS API Documentation
*/
default DeleteGeofenceCollectionResponse deleteGeofenceCollection(
DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteGeofenceCollectionRequest.Builder} avoiding
* the need to create one manually via {@link DeleteGeofenceCollectionRequest#builder()}
*
*
* @param deleteGeofenceCollectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DeleteGeofenceCollectionRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteGeofenceCollection
* @see AWS API Documentation
*/
default DeleteGeofenceCollectionResponse deleteGeofenceCollection(
Consumer deleteGeofenceCollectionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return deleteGeofenceCollection(DeleteGeofenceCollectionRequest.builder().applyMutation(deleteGeofenceCollectionRequest)
.build());
}
/**
*
* Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
*
*
* @param deleteKeyRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteKey
* @see AWS API
* Documentation
*/
default DeleteKeyResponse deleteKey(DeleteKeyRequest deleteKeyRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteKeyRequest.Builder} avoiding the need to
* create one manually via {@link DeleteKeyRequest#builder()}
*
*
* @param deleteKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DeleteKeyRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteKey
* @see AWS API
* Documentation
*/
default DeleteKeyResponse deleteKey(Consumer deleteKeyRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return deleteKey(DeleteKeyRequest.builder().applyMutation(deleteKeyRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteMapRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteMap
* @see AWS API
* Documentation
*/
default DeleteMapResponse deleteMap(DeleteMapRequest deleteMapRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteMapRequest.Builder} avoiding the need to
* create one manually via {@link DeleteMapRequest#builder()}
*
*
* @param deleteMapRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DeleteMapRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteMap
* @see AWS API
* Documentation
*/
default DeleteMapResponse deleteMap(Consumer deleteMapRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return deleteMap(DeleteMapRequest.builder().applyMutation(deleteMapRequest).build());
}
/**
*
* Deletes a place index resource from your Amazon Web Services account.
*
*
*
* This operation deletes the resource permanently.
*
*
*
* @param deletePlaceIndexRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeletePlaceIndex
* @see AWS API
* Documentation
*/
default DeletePlaceIndexResponse deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeletePlaceIndexRequest.Builder} avoiding the need
* to create one manually via {@link DeletePlaceIndexRequest#builder()}
*
*
* @param deletePlaceIndexRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DeletePlaceIndexRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeletePlaceIndex
* @see AWS API
* Documentation
*/
default DeletePlaceIndexResponse deletePlaceIndex(Consumer deletePlaceIndexRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return deletePlaceIndex(DeletePlaceIndexRequest.builder().applyMutation(deletePlaceIndexRequest).build());
}
/**
*
* Deletes a route calculator resource from your Amazon Web Services account.
*
*
*
* This operation deletes the resource permanently.
*
*
*
* @param deleteRouteCalculatorRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteRouteCalculator
* @see AWS API Documentation
*/
default DeleteRouteCalculatorResponse deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteRouteCalculatorRequest.Builder} avoiding the
* need to create one manually via {@link DeleteRouteCalculatorRequest#builder()}
*
*
* @param deleteRouteCalculatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DeleteRouteCalculatorRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteRouteCalculator
* @see AWS API Documentation
*/
default DeleteRouteCalculatorResponse deleteRouteCalculator(
Consumer deleteRouteCalculatorRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return deleteRouteCalculator(DeleteRouteCalculatorRequest.builder().applyMutation(deleteRouteCalculatorRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteTrackerRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteTracker
* @see AWS API
* Documentation
*/
default DeleteTrackerResponse deleteTracker(DeleteTrackerRequest deleteTrackerRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteTrackerRequest.Builder} avoiding the need to
* create one manually via {@link DeleteTrackerRequest#builder()}
*
*
* @param deleteTrackerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DeleteTrackerRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DeleteTracker
* @see AWS API
* Documentation
*/
default DeleteTrackerResponse deleteTracker(Consumer deleteTrackerRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return deleteTracker(DeleteTrackerRequest.builder().applyMutation(deleteTrackerRequest).build());
}
/**
*
* Retrieves the geofence collection details.
*
*
* @param describeGeofenceCollectionRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeGeofenceCollection
* @see AWS API Documentation
*/
default DescribeGeofenceCollectionResponse describeGeofenceCollection(
DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the geofence collection details.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeGeofenceCollectionRequest.Builder} avoiding
* the need to create one manually via {@link DescribeGeofenceCollectionRequest#builder()}
*
*
* @param describeGeofenceCollectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DescribeGeofenceCollectionRequest.Builder} to create
* a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeGeofenceCollection
* @see AWS API Documentation
*/
default DescribeGeofenceCollectionResponse describeGeofenceCollection(
Consumer describeGeofenceCollectionRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return describeGeofenceCollection(DescribeGeofenceCollectionRequest.builder()
.applyMutation(describeGeofenceCollectionRequest).build());
}
/**
*
* Retrieves the API key resource details.
*
*
* @param describeKeyRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeKey
* @see AWS API
* Documentation
*/
default DescribeKeyResponse describeKey(DescribeKeyRequest describeKeyRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the API key resource details.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeKeyRequest.Builder} avoiding the need to
* create one manually via {@link DescribeKeyRequest#builder()}
*
*
* @param describeKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DescribeKeyRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeKey
* @see AWS API
* Documentation
*/
default DescribeKeyResponse describeKey(Consumer describeKeyRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return describeKey(DescribeKeyRequest.builder().applyMutation(describeKeyRequest).build());
}
/**
*
* Retrieves the map resource details.
*
*
* @param describeMapRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeMap
* @see AWS API
* Documentation
*/
default DescribeMapResponse describeMap(DescribeMapRequest describeMapRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the map resource details.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeMapRequest.Builder} avoiding the need to
* create one manually via {@link DescribeMapRequest#builder()}
*
*
* @param describeMapRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DescribeMapRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeMap
* @see AWS API
* Documentation
*/
default DescribeMapResponse describeMap(Consumer describeMapRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return describeMap(DescribeMapRequest.builder().applyMutation(describeMapRequest).build());
}
/**
*
* Retrieves the place index resource details.
*
*
* @param describePlaceIndexRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribePlaceIndex
* @see AWS
* API Documentation
*/
default DescribePlaceIndexResponse describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the place index resource details.
*
*
*
* This is a convenience which creates an instance of the {@link DescribePlaceIndexRequest.Builder} avoiding the
* need to create one manually via {@link DescribePlaceIndexRequest#builder()}
*
*
* @param describePlaceIndexRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DescribePlaceIndexRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribePlaceIndex
* @see AWS
* API Documentation
*/
default DescribePlaceIndexResponse describePlaceIndex(Consumer describePlaceIndexRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return describePlaceIndex(DescribePlaceIndexRequest.builder().applyMutation(describePlaceIndexRequest).build());
}
/**
*
* Retrieves the route calculator resource details.
*
*
* @param describeRouteCalculatorRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeRouteCalculator
* @see AWS API Documentation
*/
default DescribeRouteCalculatorResponse describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the route calculator resource details.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeRouteCalculatorRequest.Builder} avoiding
* the need to create one manually via {@link DescribeRouteCalculatorRequest#builder()}
*
*
* @param describeRouteCalculatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DescribeRouteCalculatorRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeRouteCalculator
* @see AWS API Documentation
*/
default DescribeRouteCalculatorResponse describeRouteCalculator(
Consumer describeRouteCalculatorRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return describeRouteCalculator(DescribeRouteCalculatorRequest.builder().applyMutation(describeRouteCalculatorRequest)
.build());
}
/**
*
* Retrieves the tracker resource details.
*
*
* @param describeTrackerRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeTracker
* @see AWS API
* Documentation
*/
default DescribeTrackerResponse describeTracker(DescribeTrackerRequest describeTrackerRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the tracker resource details.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeTrackerRequest.Builder} avoiding the need
* to create one manually via {@link DescribeTrackerRequest#builder()}
*
*
* @param describeTrackerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DescribeTrackerRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DescribeTracker
* @see AWS API
* Documentation
*/
default DescribeTrackerResponse describeTracker(Consumer describeTrackerRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return describeTracker(DescribeTrackerRequest.builder().applyMutation(describeTrackerRequest).build());
}
/**
*
* 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.
*
*
*
* @param disassociateTrackerConsumerRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DisassociateTrackerConsumer
* @see AWS API Documentation
*/
default DisassociateTrackerConsumerResponse disassociateTrackerConsumer(
DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DisassociateTrackerConsumerRequest.Builder}
* avoiding the need to create one manually via {@link DisassociateTrackerConsumerRequest#builder()}
*
*
* @param disassociateTrackerConsumerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.DisassociateTrackerConsumerRequest.Builder} to
* create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.DisassociateTrackerConsumer
* @see AWS API Documentation
*/
default DisassociateTrackerConsumerResponse disassociateTrackerConsumer(
Consumer disassociateTrackerConsumerRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return disassociateTrackerConsumer(DisassociateTrackerConsumerRequest.builder()
.applyMutation(disassociateTrackerConsumerRequest).build());
}
/**
*
* Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts
* three states for which a device can be in relative to a geofence:
*
*
* ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at
* its current speed within time horizon window.
*
*
* EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its
* current speed within time horizon window.
*
*
* IDLE: If a device is inside of a geofence, and the device is not moving.
*
*
* @param forecastGeofenceEventsRequest
* @return Result of the ForecastGeofenceEvents operation returned by the service.
* @throws InternalServerException
* The request has failed to process because of an unknown server error, exception, or failure.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ForecastGeofenceEvents
* @see AWS API Documentation
*/
default ForecastGeofenceEventsResponse forecastGeofenceEvents(ForecastGeofenceEventsRequest forecastGeofenceEventsRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts
* three states for which a device can be in relative to a geofence:
*
*
* ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at
* its current speed within time horizon window.
*
*
* EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its
* current speed within time horizon window.
*
*
* IDLE: If a device is inside of a geofence, and the device is not moving.
*
*
*
* This is a convenience which creates an instance of the {@link ForecastGeofenceEventsRequest.Builder} avoiding the
* need to create one manually via {@link ForecastGeofenceEventsRequest#builder()}
*
*
* @param forecastGeofenceEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ForecastGeofenceEventsRequest.Builder} to create a
* request.
* @return Result of the ForecastGeofenceEvents operation returned by the service.
* @throws InternalServerException
* The request has failed to process because of an unknown server error, exception, or failure.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ForecastGeofenceEvents
* @see AWS API Documentation
*/
default ForecastGeofenceEventsResponse forecastGeofenceEvents(
Consumer forecastGeofenceEventsRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return forecastGeofenceEvents(ForecastGeofenceEventsRequest.builder().applyMutation(forecastGeofenceEventsRequest)
.build());
}
/**
*
* This is a variant of
* {@link #forecastGeofenceEvents(software.amazon.awssdk.services.location.model.ForecastGeofenceEventsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ForecastGeofenceEventsIterable responses = client.forecastGeofenceEventsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.location.paginators.ForecastGeofenceEventsIterable responses = client
* .forecastGeofenceEventsPaginator(request);
* for (software.amazon.awssdk.services.location.model.ForecastGeofenceEventsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ForecastGeofenceEventsIterable responses = client.forecastGeofenceEventsPaginator(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
* {@link #forecastGeofenceEvents(software.amazon.awssdk.services.location.model.ForecastGeofenceEventsRequest)}
* operation.
*
*
* @param forecastGeofenceEventsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ForecastGeofenceEvents
* @see AWS API Documentation
*/
default ForecastGeofenceEventsIterable forecastGeofenceEventsPaginator(
ForecastGeofenceEventsRequest forecastGeofenceEventsRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return new ForecastGeofenceEventsIterable(this, forecastGeofenceEventsRequest);
}
/**
*
* This is a variant of
* {@link #forecastGeofenceEvents(software.amazon.awssdk.services.location.model.ForecastGeofenceEventsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ForecastGeofenceEventsIterable responses = client.forecastGeofenceEventsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.location.paginators.ForecastGeofenceEventsIterable responses = client
* .forecastGeofenceEventsPaginator(request);
* for (software.amazon.awssdk.services.location.model.ForecastGeofenceEventsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ForecastGeofenceEventsIterable responses = client.forecastGeofenceEventsPaginator(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
* {@link #forecastGeofenceEvents(software.amazon.awssdk.services.location.model.ForecastGeofenceEventsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ForecastGeofenceEventsRequest.Builder} avoiding the
* need to create one manually via {@link ForecastGeofenceEventsRequest#builder()}
*
*
* @param forecastGeofenceEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ForecastGeofenceEventsRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ForecastGeofenceEvents
* @see AWS API Documentation
*/
default ForecastGeofenceEventsIterable forecastGeofenceEventsPaginator(
Consumer forecastGeofenceEventsRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return forecastGeofenceEventsPaginator(ForecastGeofenceEventsRequest.builder()
.applyMutation(forecastGeofenceEventsRequest).build());
}
/**
*
* Retrieves a device's most recent position according to its sample time.
*
*
*
* Device positions are deleted after 30 days.
*
*
*
* @param getDevicePositionRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetDevicePosition
* @see AWS
* API Documentation
*/
default GetDevicePositionResponse getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetDevicePositionRequest.Builder} avoiding the need
* to create one manually via {@link GetDevicePositionRequest#builder()}
*
*
* @param getDevicePositionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetDevicePositionRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetDevicePosition
* @see AWS
* API Documentation
*/
default GetDevicePositionResponse getDevicePosition(Consumer getDevicePositionRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return getDevicePosition(GetDevicePositionRequest.builder().applyMutation(getDevicePositionRequest).build());
}
/**
*
* Retrieves the device position history from a tracker resource within a specified range of time.
*
*
*
* Device positions are deleted after 30 days.
*
*
*
* @param getDevicePositionHistoryRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetDevicePositionHistory
* @see AWS API Documentation
*/
default GetDevicePositionHistoryResponse getDevicePositionHistory(
GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetDevicePositionHistoryRequest.Builder} avoiding
* the need to create one manually via {@link GetDevicePositionHistoryRequest#builder()}
*
*
* @param getDevicePositionHistoryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetDevicePositionHistory
* @see AWS API Documentation
*/
default GetDevicePositionHistoryResponse getDevicePositionHistory(
Consumer getDevicePositionHistoryRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return getDevicePositionHistory(GetDevicePositionHistoryRequest.builder().applyMutation(getDevicePositionHistoryRequest)
.build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client.getDevicePositionHistoryPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)}
* operation.
*
*
* @param getDevicePositionHistoryRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetDevicePositionHistory
* @see AWS API Documentation
*/
default GetDevicePositionHistoryIterable getDevicePositionHistoryPaginator(
GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return new GetDevicePositionHistoryIterable(this, getDevicePositionHistoryRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client.getDevicePositionHistoryPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetDevicePositionHistoryRequest.Builder} avoiding
* the need to create one manually via {@link GetDevicePositionHistoryRequest#builder()}
*
*
* @param getDevicePositionHistoryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetDevicePositionHistory
* @see AWS API Documentation
*/
default GetDevicePositionHistoryIterable getDevicePositionHistoryPaginator(
Consumer getDevicePositionHistoryRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return getDevicePositionHistoryPaginator(GetDevicePositionHistoryRequest.builder()
.applyMutation(getDevicePositionHistoryRequest).build());
}
/**
*
* Retrieves the geofence details from a geofence collection.
*
*
*
* The returned geometry will always match the geometry format used when the geofence was created.
*
*
*
* @param getGeofenceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetGeofence
* @see AWS API
* Documentation
*/
default GetGeofenceResponse getGeofence(GetGeofenceRequest getGeofenceRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the geofence details from a geofence collection.
*
*
*
* The returned geometry will always match the geometry format used when the geofence was created.
*
*
*
* This is a convenience which creates an instance of the {@link GetGeofenceRequest.Builder} avoiding the need to
* create one manually via {@link GetGeofenceRequest#builder()}
*
*
* @param getGeofenceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetGeofenceRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetGeofence
* @see AWS API
* Documentation
*/
default GetGeofenceResponse getGeofence(Consumer getGeofenceRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return getGeofence(GetGeofenceRequest.builder().applyMutation(getGeofenceRequest).build());
}
/**
*
* Retrieves glyphs used to display labels on a map.
*
*
* @param getMapGlyphsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetMapGlyphs
* @see AWS API
* Documentation
*/
default GetMapGlyphsResponse getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves glyphs used to display labels on a map.
*
*
*
* This is a convenience which creates an instance of the {@link GetMapGlyphsRequest.Builder} avoiding the need to
* create one manually via {@link GetMapGlyphsRequest#builder()}
*
*
* @param getMapGlyphsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetMapGlyphsRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetMapGlyphs
* @see AWS API
* Documentation
*/
default GetMapGlyphsResponse getMapGlyphs(Consumer getMapGlyphsRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return getMapGlyphs(GetMapGlyphsRequest.builder().applyMutation(getMapGlyphsRequest).build());
}
/**
*
* 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.
*
*
* @param getMapSpritesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetMapSprites
* @see AWS API
* Documentation
*/
default GetMapSpritesResponse getMapSprites(GetMapSpritesRequest getMapSpritesRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetMapSpritesRequest.Builder} avoiding the need to
* create one manually via {@link GetMapSpritesRequest#builder()}
*
*
* @param getMapSpritesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetMapSpritesRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetMapSprites
* @see AWS API
* Documentation
*/
default GetMapSpritesResponse getMapSprites(Consumer getMapSpritesRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return getMapSprites(GetMapSpritesRequest.builder().applyMutation(getMapSpritesRequest).build());
}
/**
*
* 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.
*
*
* @param getMapStyleDescriptorRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetMapStyleDescriptor
* @see AWS API Documentation
*/
default GetMapStyleDescriptorResponse getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetMapStyleDescriptorRequest.Builder} avoiding the
* need to create one manually via {@link GetMapStyleDescriptorRequest#builder()}
*
*
* @param getMapStyleDescriptorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetMapStyleDescriptorRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetMapStyleDescriptor
* @see AWS API Documentation
*/
default GetMapStyleDescriptorResponse getMapStyleDescriptor(
Consumer getMapStyleDescriptorRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return getMapStyleDescriptor(GetMapStyleDescriptorRequest.builder().applyMutation(getMapStyleDescriptorRequest).build());
}
/**
*
* 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).
*
*
* @param getMapTileRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetMapTile
* @see AWS API
* Documentation
*/
default GetMapTileResponse getMapTile(GetMapTileRequest getMapTileRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetMapTileRequest.Builder} avoiding the need to
* create one manually via {@link GetMapTileRequest#builder()}
*
*
* @param getMapTileRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetMapTileRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetMapTile
* @see AWS API
* Documentation
*/
default GetMapTileResponse getMapTile(Consumer getMapTileRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return getMapTile(GetMapTileRequest.builder().applyMutation(getMapTileRequest).build());
}
/**
*
* Finds a place by its unique ID. A PlaceId is returned by other search operations.
*
*
*
* A PlaceId is valid only if all of the following are the same in the original search request and the call to
* GetPlace.
*
*
* -
*
* Customer Amazon Web Services account
*
*
* -
*
* Amazon Web Services Region
*
*
* -
*
* Data provider specified in the place index resource
*
*
*
*
*
* @param getPlaceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetPlace
* @see AWS API
* Documentation
*/
default GetPlaceResponse getPlace(GetPlaceRequest getPlaceRequest) throws InternalServerException, ResourceNotFoundException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Finds a place by its unique ID. A PlaceId is returned by other search operations.
*
*
*
* A PlaceId is valid only if all of the following are the same in the original search request and the call to
* GetPlace.
*
*
* -
*
* Customer Amazon Web Services account
*
*
* -
*
* Amazon Web Services Region
*
*
* -
*
* Data provider specified in the place index resource
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetPlaceRequest.Builder} avoiding the need to
* create one manually via {@link GetPlaceRequest#builder()}
*
*
* @param getPlaceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.GetPlaceRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.GetPlace
* @see AWS API
* Documentation
*/
default GetPlaceResponse getPlace(Consumer getPlaceRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return getPlace(GetPlaceRequest.builder().applyMutation(getPlaceRequest).build());
}
/**
*
* A batch request to retrieve all device positions.
*
*
* @param listDevicePositionsRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListDevicePositions
* @see AWS
* API Documentation
*/
default ListDevicePositionsResponse listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* A batch request to retrieve all device positions.
*
*
*
* This is a convenience which creates an instance of the {@link ListDevicePositionsRequest.Builder} avoiding the
* need to create one manually via {@link ListDevicePositionsRequest#builder()}
*
*
* @param listDevicePositionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListDevicePositionsRequest.Builder} to create a
* request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListDevicePositions
* @see AWS
* API Documentation
*/
default ListDevicePositionsResponse listDevicePositions(
Consumer listDevicePositionsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listDevicePositions(ListDevicePositionsRequest.builder().applyMutation(listDevicePositionsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable responses = client.listDevicePositionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)}
* operation.
*
*
* @param listDevicePositionsRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListDevicePositions
* @see AWS
* API Documentation
*/
default ListDevicePositionsIterable listDevicePositionsPaginator(ListDevicePositionsRequest listDevicePositionsRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return new ListDevicePositionsIterable(this, listDevicePositionsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListDevicePositionsIterable responses = client.listDevicePositionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDevicePositionsRequest.Builder} avoiding the
* need to create one manually via {@link ListDevicePositionsRequest#builder()}
*
*
* @param listDevicePositionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListDevicePositionsRequest.Builder} to create a
* request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListDevicePositions
* @see AWS
* API Documentation
*/
default ListDevicePositionsIterable listDevicePositionsPaginator(
Consumer listDevicePositionsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listDevicePositionsPaginator(ListDevicePositionsRequest.builder().applyMutation(listDevicePositionsRequest)
.build());
}
/**
*
* Lists geofence collections in your Amazon Web Services account.
*
*
* @param listGeofenceCollectionsRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListGeofenceCollections
* @see AWS API Documentation
*/
default ListGeofenceCollectionsResponse listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists geofence collections in your Amazon Web Services account.
*
*
*
* This is a convenience which creates an instance of the {@link ListGeofenceCollectionsRequest.Builder} avoiding
* the need to create one manually via {@link ListGeofenceCollectionsRequest#builder()}
*
*
* @param listGeofenceCollectionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest.Builder} to create a
* request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListGeofenceCollections
* @see AWS API Documentation
*/
default ListGeofenceCollectionsResponse listGeofenceCollections(
Consumer listGeofenceCollectionsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listGeofenceCollections(ListGeofenceCollectionsRequest.builder().applyMutation(listGeofenceCollectionsRequest)
.build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable responses = client.listGeofenceCollectionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)}
* operation.
*
*
* @param listGeofenceCollectionsRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListGeofenceCollections
* @see AWS API Documentation
*/
default ListGeofenceCollectionsIterable listGeofenceCollectionsPaginator(
ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException,
ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return new ListGeofenceCollectionsIterable(this, listGeofenceCollectionsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsIterable responses = client.listGeofenceCollectionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListGeofenceCollectionsRequest.Builder} avoiding
* the need to create one manually via {@link ListGeofenceCollectionsRequest#builder()}
*
*
* @param listGeofenceCollectionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest.Builder} to create a
* request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListGeofenceCollections
* @see AWS API Documentation
*/
default ListGeofenceCollectionsIterable listGeofenceCollectionsPaginator(
Consumer listGeofenceCollectionsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listGeofenceCollectionsPaginator(ListGeofenceCollectionsRequest.builder()
.applyMutation(listGeofenceCollectionsRequest).build());
}
/**
*
* Lists geofences stored in a given geofence collection.
*
*
* @param listGeofencesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListGeofences
* @see AWS API
* Documentation
*/
default ListGeofencesResponse listGeofences(ListGeofencesRequest listGeofencesRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists geofences stored in a given geofence collection.
*
*
*
* This is a convenience which creates an instance of the {@link ListGeofencesRequest.Builder} avoiding the need to
* create one manually via {@link ListGeofencesRequest#builder()}
*
*
* @param listGeofencesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListGeofencesRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListGeofences
* @see AWS API
* Documentation
*/
default ListGeofencesResponse listGeofences(Consumer listGeofencesRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return listGeofences(ListGeofencesRequest.builder().applyMutation(listGeofencesRequest).build());
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)} operation.
*
*
* @param listGeofencesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListGeofences
* @see AWS API
* Documentation
*/
default ListGeofencesIterable listGeofencesPaginator(ListGeofencesRequest listGeofencesRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return new ListGeofencesIterable(this, listGeofencesRequest);
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListGeofencesRequest.Builder} avoiding the need to
* create one manually via {@link ListGeofencesRequest#builder()}
*
*
* @param listGeofencesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListGeofencesRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListGeofences
* @see AWS API
* Documentation
*/
default ListGeofencesIterable listGeofencesPaginator(Consumer listGeofencesRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return listGeofencesPaginator(ListGeofencesRequest.builder().applyMutation(listGeofencesRequest).build());
}
/**
*
* Lists API key resources in your Amazon Web Services account.
*
*
* @param listKeysRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListKeys
* @see AWS API
* Documentation
*/
default ListKeysResponse listKeys(ListKeysRequest listKeysRequest) throws InternalServerException, AccessDeniedException,
ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists API key resources in your Amazon Web Services account.
*
*
*
* This is a convenience which creates an instance of the {@link ListKeysRequest.Builder} avoiding the need to
* create one manually via {@link ListKeysRequest#builder()}
*
*
* @param listKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListKeysRequest.Builder} to create a request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListKeys
* @see AWS API
* Documentation
*/
default ListKeysResponse listKeys(Consumer listKeysRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listKeys(ListKeysRequest.builder().applyMutation(listKeysRequest).build());
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)} operation.
*
*
* @param listKeysRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListKeys
* @see AWS API
* Documentation
*/
default ListKeysIterable listKeysPaginator(ListKeysRequest listKeysRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return new ListKeysIterable(this, listKeysRequest);
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listKeys(software.amazon.awssdk.services.location.model.ListKeysRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListKeysRequest.Builder} avoiding the need to
* create one manually via {@link ListKeysRequest#builder()}
*
*
* @param listKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListKeysRequest.Builder} to create a request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListKeys
* @see AWS API
* Documentation
*/
default ListKeysIterable listKeysPaginator(Consumer listKeysRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listKeysPaginator(ListKeysRequest.builder().applyMutation(listKeysRequest).build());
}
/**
*
* Lists map resources in your Amazon Web Services account.
*
*
* @param listMapsRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListMaps
* @see AWS API
* Documentation
*/
default ListMapsResponse listMaps(ListMapsRequest listMapsRequest) throws InternalServerException, AccessDeniedException,
ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists map resources in your Amazon Web Services account.
*
*
*
* This is a convenience which creates an instance of the {@link ListMapsRequest.Builder} avoiding the need to
* create one manually via {@link ListMapsRequest#builder()}
*
*
* @param listMapsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListMapsRequest.Builder} to create a request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListMaps
* @see AWS API
* Documentation
*/
default ListMapsResponse listMaps(Consumer listMapsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listMaps(ListMapsRequest.builder().applyMutation(listMapsRequest).build());
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListMapsIterable responses = client.listMapsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)} operation.
*
*
* @param listMapsRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListMaps
* @see AWS API
* Documentation
*/
default ListMapsIterable listMapsPaginator(ListMapsRequest listMapsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return new ListMapsIterable(this, listMapsRequest);
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListMapsIterable responses = client.listMapsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListMapsRequest.Builder} avoiding the need to
* create one manually via {@link ListMapsRequest#builder()}
*
*
* @param listMapsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListMapsRequest.Builder} to create a request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListMaps
* @see AWS API
* Documentation
*/
default ListMapsIterable listMapsPaginator(Consumer listMapsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listMapsPaginator(ListMapsRequest.builder().applyMutation(listMapsRequest).build());
}
/**
*
* Lists place index resources in your Amazon Web Services account.
*
*
* @param listPlaceIndexesRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListPlaceIndexes
* @see AWS API
* Documentation
*/
default ListPlaceIndexesResponse listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists place index resources in your Amazon Web Services account.
*
*
*
* This is a convenience which creates an instance of the {@link ListPlaceIndexesRequest.Builder} avoiding the need
* to create one manually via {@link ListPlaceIndexesRequest#builder()}
*
*
* @param listPlaceIndexesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest.Builder} to create a
* request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListPlaceIndexes
* @see AWS API
* Documentation
*/
default ListPlaceIndexesResponse listPlaceIndexes(Consumer listPlaceIndexesRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return listPlaceIndexes(ListPlaceIndexesRequest.builder().applyMutation(listPlaceIndexesRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable responses = client.listPlaceIndexesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)} operation.
*
*
* @param listPlaceIndexesRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListPlaceIndexes
* @see AWS API
* Documentation
*/
default ListPlaceIndexesIterable listPlaceIndexesPaginator(ListPlaceIndexesRequest listPlaceIndexesRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return new ListPlaceIndexesIterable(this, listPlaceIndexesRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListPlaceIndexesIterable responses = client.listPlaceIndexesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListPlaceIndexesRequest.Builder} avoiding the need
* to create one manually via {@link ListPlaceIndexesRequest#builder()}
*
*
* @param listPlaceIndexesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest.Builder} to create a
* request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListPlaceIndexes
* @see AWS API
* Documentation
*/
default ListPlaceIndexesIterable listPlaceIndexesPaginator(Consumer listPlaceIndexesRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return listPlaceIndexesPaginator(ListPlaceIndexesRequest.builder().applyMutation(listPlaceIndexesRequest).build());
}
/**
*
* Lists route calculator resources in your Amazon Web Services account.
*
*
* @param listRouteCalculatorsRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListRouteCalculators
* @see AWS
* API Documentation
*/
default ListRouteCalculatorsResponse listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists route calculator resources in your Amazon Web Services account.
*
*
*
* This is a convenience which creates an instance of the {@link ListRouteCalculatorsRequest.Builder} avoiding the
* need to create one manually via {@link ListRouteCalculatorsRequest#builder()}
*
*
* @param listRouteCalculatorsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest.Builder} to create a
* request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListRouteCalculators
* @see AWS
* API Documentation
*/
default ListRouteCalculatorsResponse listRouteCalculators(
Consumer listRouteCalculatorsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listRouteCalculators(ListRouteCalculatorsRequest.builder().applyMutation(listRouteCalculatorsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable responses = client.listRouteCalculatorsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)}
* operation.
*
*
* @param listRouteCalculatorsRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListRouteCalculators
* @see AWS
* API Documentation
*/
default ListRouteCalculatorsIterable listRouteCalculatorsPaginator(ListRouteCalculatorsRequest listRouteCalculatorsRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return new ListRouteCalculatorsIterable(this, listRouteCalculatorsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsIterable responses = client.listRouteCalculatorsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRouteCalculatorsRequest.Builder} avoiding the
* need to create one manually via {@link ListRouteCalculatorsRequest#builder()}
*
*
* @param listRouteCalculatorsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest.Builder} to create a
* request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListRouteCalculators
* @see AWS
* API Documentation
*/
default ListRouteCalculatorsIterable listRouteCalculatorsPaginator(
Consumer listRouteCalculatorsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return listRouteCalculatorsPaginator(ListRouteCalculatorsRequest.builder().applyMutation(listRouteCalculatorsRequest)
.build());
}
/**
*
* Returns a list of tags that are applied to the specified Amazon Location resource.
*
*
* @param listTagsForResourceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of tags that are applied to the specified Amazon Location resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListTagsForResourceRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Lists geofence collections currently associated to the given tracker resource.
*
*
* @param listTrackerConsumersRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTrackerConsumers
* @see AWS
* API Documentation
*/
default ListTrackerConsumersResponse listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists geofence collections currently associated to the given tracker resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTrackerConsumersRequest.Builder} avoiding the
* need to create one manually via {@link ListTrackerConsumersRequest#builder()}
*
*
* @param listTrackerConsumersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTrackerConsumers
* @see AWS
* API Documentation
*/
default ListTrackerConsumersResponse listTrackerConsumers(
Consumer listTrackerConsumersRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return listTrackerConsumers(ListTrackerConsumersRequest.builder().applyMutation(listTrackerConsumersRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable responses = client.listTrackerConsumersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)}
* operation.
*
*
* @param listTrackerConsumersRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTrackerConsumers
* @see AWS
* API Documentation
*/
default ListTrackerConsumersIterable listTrackerConsumersPaginator(ListTrackerConsumersRequest listTrackerConsumersRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return new ListTrackerConsumersIterable(this, listTrackerConsumersRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListTrackerConsumersIterable responses = client.listTrackerConsumersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListTrackerConsumersRequest.Builder} avoiding the
* need to create one manually via {@link ListTrackerConsumersRequest#builder()}
*
*
* @param listTrackerConsumersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTrackerConsumers
* @see AWS
* API Documentation
*/
default ListTrackerConsumersIterable listTrackerConsumersPaginator(
Consumer listTrackerConsumersRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return listTrackerConsumersPaginator(ListTrackerConsumersRequest.builder().applyMutation(listTrackerConsumersRequest)
.build());
}
/**
*
* Lists tracker resources in your Amazon Web Services account.
*
*
* @param listTrackersRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTrackers
* @see AWS API
* Documentation
*/
default ListTrackersResponse listTrackers(ListTrackersRequest listTrackersRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Lists tracker resources in your Amazon Web Services account.
*
*
*
* This is a convenience which creates an instance of the {@link ListTrackersRequest.Builder} avoiding the need to
* create one manually via {@link ListTrackersRequest#builder()}
*
*
* @param listTrackersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListTrackersRequest.Builder} to create a request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTrackers
* @see AWS API
* Documentation
*/
default ListTrackersResponse listTrackers(Consumer listTrackersRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return listTrackers(ListTrackersRequest.builder().applyMutation(listTrackersRequest).build());
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListTrackersIterable responses = client.listTrackersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)} operation.
*
*
* @param listTrackersRequest
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTrackers
* @see AWS API
* Documentation
*/
default ListTrackersIterable listTrackersPaginator(ListTrackersRequest listTrackersRequest) throws InternalServerException,
AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException,
LocationException {
return new ListTrackersIterable(this, listTrackersRequest);
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* software.amazon.awssdk.services.location.paginators.ListTrackersIterable responses = client.listTrackersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListTrackersRequest.Builder} avoiding the need to
* create one manually via {@link ListTrackersRequest#builder()}
*
*
* @param listTrackersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.ListTrackersRequest.Builder} to create a request.
* @return 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.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.ListTrackers
* @see AWS API
* Documentation
*/
default ListTrackersIterable listTrackersPaginator(Consumer listTrackersRequest)
throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return listTrackersPaginator(ListTrackersRequest.builder().applyMutation(listTrackersRequest).build());
}
/**
*
* 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.
*
*
* @param putGeofenceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.PutGeofence
* @see AWS API
* Documentation
*/
default PutGeofenceResponse putGeofence(PutGeofenceRequest putGeofenceRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException,
AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutGeofenceRequest.Builder} avoiding the need to
* create one manually via {@link PutGeofenceRequest#builder()}
*
*
* @param putGeofenceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.PutGeofenceRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws ConflictException
* The request was unsuccessful because of a conflict.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.PutGeofence
* @see AWS API
* Documentation
*/
default PutGeofenceResponse putGeofence(Consumer putGeofenceRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException,
ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return putGeofence(PutGeofenceRequest.builder().applyMutation(putGeofenceRequest).build());
}
/**
*
* Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of
* interest near a given position.
*
*
* @param searchPlaceIndexForPositionRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.SearchPlaceIndexForPosition
* @see AWS API Documentation
*/
default SearchPlaceIndexForPositionResponse searchPlaceIndexForPosition(
SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SearchPlaceIndexForPositionRequest.Builder}
* avoiding the need to create one manually via {@link SearchPlaceIndexForPositionRequest#builder()}
*
*
* @param searchPlaceIndexForPositionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.SearchPlaceIndexForPositionRequest.Builder} to
* create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.SearchPlaceIndexForPosition
* @see AWS API Documentation
*/
default SearchPlaceIndexForPositionResponse searchPlaceIndexForPosition(
Consumer searchPlaceIndexForPositionRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest.builder()
.applyMutation(searchPlaceIndexForPositionRequest).build());
}
/**
*
* Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This
* operation is also known as autocomplete, autosuggest, or fuzzy matching.
*
*
* Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a
* specific position on the globe.
*
*
*
* You can search for suggested place names near a specified position by using BiasPosition, or filter
* results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using
* both BiasPosition and FilterBBox in the same command returns an error.
*
*
*
* @param searchPlaceIndexForSuggestionsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.SearchPlaceIndexForSuggestions
* @see AWS API Documentation
*/
default SearchPlaceIndexForSuggestionsResponse searchPlaceIndexForSuggestions(
SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This
* operation is also known as autocomplete, autosuggest, or fuzzy matching.
*
*
* Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a
* specific position on the globe.
*
*
*
* You can search for suggested place names near a specified position by using BiasPosition, or filter
* results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using
* both BiasPosition and FilterBBox in the same command returns an error.
*
*
*
* This is a convenience which creates an instance of the {@link SearchPlaceIndexForSuggestionsRequest.Builder}
* avoiding the need to create one manually via {@link SearchPlaceIndexForSuggestionsRequest#builder()}
*
*
* @param searchPlaceIndexForSuggestionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.SearchPlaceIndexForSuggestionsRequest.Builder} to
* create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.SearchPlaceIndexForSuggestions
* @see AWS API Documentation
*/
default SearchPlaceIndexForSuggestionsResponse searchPlaceIndexForSuggestions(
Consumer searchPlaceIndexForSuggestionsRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest.builder()
.applyMutation(searchPlaceIndexForSuggestionsRequest).build());
}
/**
*
* Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of
* interest.
*
*
* Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a
* specific position on the globe.
*
*
*
* You can search for places near a given position using BiasPosition, or filter results within a
* bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
*
*
*
* Search results are returned in order of highest to lowest relevance.
*
*
* @param searchPlaceIndexForTextRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.SearchPlaceIndexForText
* @see AWS API Documentation
*/
default SearchPlaceIndexForTextResponse searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of
* interest.
*
*
* Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a
* specific position on the globe.
*
*
*
* You can search for places near a given position using BiasPosition, or filter results within a
* bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
*
*
*
* Search results are returned in order of highest to lowest relevance.
*
*
*
* This is a convenience which creates an instance of the {@link SearchPlaceIndexForTextRequest.Builder} avoiding
* the need to create one manually via {@link SearchPlaceIndexForTextRequest#builder()}
*
*
* @param searchPlaceIndexForTextRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.SearchPlaceIndexForTextRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.SearchPlaceIndexForText
* @see AWS API Documentation
*/
default SearchPlaceIndexForTextResponse searchPlaceIndexForText(
Consumer searchPlaceIndexForTextRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return searchPlaceIndexForText(SearchPlaceIndexForTextRequest.builder().applyMutation(searchPlaceIndexForTextRequest)
.build());
}
/**
*
* Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
*
*
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
* granting a user permission to access or change only resources with certain tag values.
*
*
* You can use the TagResource operation with an Amazon Location Service resource that already has
* tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the
* resource. If you specify a tag key that's already associated with the resource, the new tag value that you
* specify replaces the previous value for that tag.
*
*
* You can associate up to 50 tags with a resource.
*
*
* @param tagResourceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
*
*
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
* granting a user permission to access or change only resources with certain tag values.
*
*
* You can use the TagResource operation with an Amazon Location Service resource that already has
* tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the
* resource. If you specify a tag key that's already associated with the resource, the new tag value that you
* specify replaces the previous value for that tag.
*
*
* You can associate up to 50 tags with a resource.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.TagResourceRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes one or more tags from the specified Amazon Location resource.
*
*
* @param untagResourceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more tags from the specified Amazon Location resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.UntagResourceRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates the specified properties of a given geofence collection.
*
*
* @param updateGeofenceCollectionRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateGeofenceCollection
* @see AWS API Documentation
*/
default UpdateGeofenceCollectionResponse updateGeofenceCollection(
UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified properties of a given geofence collection.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateGeofenceCollectionRequest.Builder} avoiding
* the need to create one manually via {@link UpdateGeofenceCollectionRequest#builder()}
*
*
* @param updateGeofenceCollectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.UpdateGeofenceCollectionRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateGeofenceCollection
* @see AWS API Documentation
*/
default UpdateGeofenceCollectionResponse updateGeofenceCollection(
Consumer updateGeofenceCollectionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return updateGeofenceCollection(UpdateGeofenceCollectionRequest.builder().applyMutation(updateGeofenceCollectionRequest)
.build());
}
/**
*
* Updates the specified properties of a given API key resource.
*
*
* @param updateKeyRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateKey
* @see AWS API
* Documentation
*/
default UpdateKeyResponse updateKey(UpdateKeyRequest updateKeyRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified properties of a given API key resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateKeyRequest.Builder} avoiding the need to
* create one manually via {@link UpdateKeyRequest#builder()}
*
*
* @param updateKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.UpdateKeyRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateKey
* @see AWS API
* Documentation
*/
default UpdateKeyResponse updateKey(Consumer updateKeyRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return updateKey(UpdateKeyRequest.builder().applyMutation(updateKeyRequest).build());
}
/**
*
* Updates the specified properties of a given map resource.
*
*
* @param updateMapRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateMap
* @see AWS API
* Documentation
*/
default UpdateMapResponse updateMap(UpdateMapRequest updateMapRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified properties of a given map resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateMapRequest.Builder} avoiding the need to
* create one manually via {@link UpdateMapRequest#builder()}
*
*
* @param updateMapRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.UpdateMapRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateMap
* @see AWS API
* Documentation
*/
default UpdateMapResponse updateMap(Consumer updateMapRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return updateMap(UpdateMapRequest.builder().applyMutation(updateMapRequest).build());
}
/**
*
* Updates the specified properties of a given place index resource.
*
*
* @param updatePlaceIndexRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdatePlaceIndex
* @see AWS API
* Documentation
*/
default UpdatePlaceIndexResponse updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified properties of a given place index resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdatePlaceIndexRequest.Builder} avoiding the need
* to create one manually via {@link UpdatePlaceIndexRequest#builder()}
*
*
* @param updatePlaceIndexRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.UpdatePlaceIndexRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdatePlaceIndex
* @see AWS API
* Documentation
*/
default UpdatePlaceIndexResponse updatePlaceIndex(Consumer updatePlaceIndexRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return updatePlaceIndex(UpdatePlaceIndexRequest.builder().applyMutation(updatePlaceIndexRequest).build());
}
/**
*
* Updates the specified properties for a given route calculator resource.
*
*
* @param updateRouteCalculatorRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateRouteCalculator
* @see AWS API Documentation
*/
default UpdateRouteCalculatorResponse updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified properties for a given route calculator resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRouteCalculatorRequest.Builder} avoiding the
* need to create one manually via {@link UpdateRouteCalculatorRequest#builder()}
*
*
* @param updateRouteCalculatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.UpdateRouteCalculatorRequest.Builder} to create a
* request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateRouteCalculator
* @see AWS API Documentation
*/
default UpdateRouteCalculatorResponse updateRouteCalculator(
Consumer updateRouteCalculatorRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return updateRouteCalculator(UpdateRouteCalculatorRequest.builder().applyMutation(updateRouteCalculatorRequest).build());
}
/**
*
* Updates the specified properties of a given tracker resource.
*
*
* @param updateTrackerRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateTracker
* @see AWS API
* Documentation
*/
default UpdateTrackerResponse updateTracker(UpdateTrackerRequest updateTrackerRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified properties of a given tracker resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateTrackerRequest.Builder} avoiding the need to
* create one manually via {@link UpdateTrackerRequest#builder()}
*
*
* @param updateTrackerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.UpdateTrackerRequest.Builder} to create a request.
* @return 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.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.UpdateTracker
* @see AWS API
* Documentation
*/
default UpdateTrackerResponse updateTracker(Consumer updateTrackerRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
return updateTracker(UpdateTrackerRequest.builder().applyMutation(updateTrackerRequest).build());
}
/**
*
* Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by
* comparing it to an inferred position estimated based on the device's state.
*
*
* @param verifyDevicePositionRequest
* @return Result of the VerifyDevicePosition operation returned by the service.
* @throws InternalServerException
* The request has failed to process because of an unknown server error, exception, or failure.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.VerifyDevicePosition
* @see AWS
* API Documentation
*/
default VerifyDevicePositionResponse verifyDevicePosition(VerifyDevicePositionRequest verifyDevicePositionRequest)
throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException,
ThrottlingException, AwsServiceException, SdkClientException, LocationException {
throw new UnsupportedOperationException();
}
/**
*
* Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by
* comparing it to an inferred position estimated based on the device's state.
*
*
*
* This is a convenience which creates an instance of the {@link VerifyDevicePositionRequest.Builder} avoiding the
* need to create one manually via {@link VerifyDevicePositionRequest#builder()}
*
*
* @param verifyDevicePositionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.location.model.VerifyDevicePositionRequest.Builder} to create a
* request.
* @return Result of the VerifyDevicePosition operation returned by the service.
* @throws InternalServerException
* The request has failed to process because of an unknown server error, exception, or failure.
* @throws ResourceNotFoundException
* The resource that you've entered was not found in your AWS account.
* @throws AccessDeniedException
* The request was denied because of insufficient access or permissions. Check with an administrator to
* verify your permissions.
* @throws ValidationException
* The input failed to meet the constraints specified by the AWS service.
* @throws ThrottlingException
* The request was denied because of request throttling.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws LocationException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample LocationClient.VerifyDevicePosition
* @see AWS
* API Documentation
*/
default VerifyDevicePositionResponse verifyDevicePosition(
Consumer verifyDevicePositionRequest) throws InternalServerException,
ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException,
SdkClientException, LocationException {
return verifyDevicePosition(VerifyDevicePositionRequest.builder().applyMutation(verifyDevicePositionRequest).build());
}
/**
* Create a {@link LocationClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static LocationClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link LocationClient}.
*/
static LocationClientBuilder builder() {
return new DefaultLocationClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default LocationServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}