@Generated(value="software.amazon.awssdk:codegen") public interface LocationClient extends SdkClient
builder()
method.
Suite of geospatial services including Maps, Places, Tracking, and Geofencing
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AssociateTrackerConsumerResponse |
associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)
Creates an association between a geofence collection and a tracker resource.
|
default AssociateTrackerConsumerResponse |
associateTrackerConsumer(Consumer<AssociateTrackerConsumerRequest.Builder> associateTrackerConsumerRequest)
Creates an association between a geofence collection and a tracker resource.
|
default BatchDeleteGeofenceResponse |
batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
Deletes a batch of geofences from a geofence collection.
|
default BatchDeleteGeofenceResponse |
batchDeleteGeofence(Consumer<BatchDeleteGeofenceRequest.Builder> batchDeleteGeofenceRequest)
Deletes a batch of geofences from a geofence collection.
|
default BatchEvaluateGeofencesResponse |
batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
Evaluates device positions against the geofence geometries from a given geofence collection.
|
default BatchEvaluateGeofencesResponse |
batchEvaluateGeofences(Consumer<BatchEvaluateGeofencesRequest.Builder> batchEvaluateGeofencesRequest)
Evaluates device positions against the geofence geometries from a given geofence collection.
|
default BatchGetDevicePositionResponse |
batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
A batch request to retrieve all device positions.
|
default BatchGetDevicePositionResponse |
batchGetDevicePosition(Consumer<BatchGetDevicePositionRequest.Builder> batchGetDevicePositionRequest)
A batch request to retrieve all device positions.
|
default BatchPutGeofenceResponse |
batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)
A batch request for storing geofence geometries into a given geofence collection.
|
default BatchPutGeofenceResponse |
batchPutGeofence(Consumer<BatchPutGeofenceRequest.Builder> batchPutGeofenceRequest)
A batch request for storing geofence geometries into a given geofence collection.
|
default BatchUpdateDevicePositionResponse |
batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)
Uploads position update data for one or more devices to a tracker resource.
|
default BatchUpdateDevicePositionResponse |
batchUpdateDevicePosition(Consumer<BatchUpdateDevicePositionRequest.Builder> batchUpdateDevicePositionRequest)
Uploads position update data for one or more devices to a tracker resource.
|
static LocationClientBuilder |
builder()
Create a builder that can be used to configure and create a
LocationClient . |
static LocationClient |
create()
Create a
LocationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateGeofenceCollectionResponse |
createGeofenceCollection(Consumer<CreateGeofenceCollectionRequest.Builder> createGeofenceCollectionRequest)
Creates a geofence collection, which manages and stores geofences.
|
default CreateGeofenceCollectionResponse |
createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)
Creates a geofence collection, which manages and stores geofences.
|
default CreateMapResponse |
createMap(Consumer<CreateMapRequest.Builder> createMapRequest)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global
location data providers.
|
default CreateMapResponse |
createMap(CreateMapRequest createMapRequest)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global
location data providers.
|
default CreatePlaceIndexResponse |
createPlaceIndex(Consumer<CreatePlaceIndexRequest.Builder> createPlaceIndexRequest)
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced
from your chosen data provider.
|
default CreatePlaceIndexResponse |
createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced
from your chosen data provider.
|
default CreateTrackerResponse |
createTracker(Consumer<CreateTrackerRequest.Builder> createTrackerRequest)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of
devices.
|
default CreateTrackerResponse |
createTracker(CreateTrackerRequest createTrackerRequest)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of
devices.
|
default DeleteGeofenceCollectionResponse |
deleteGeofenceCollection(Consumer<DeleteGeofenceCollectionRequest.Builder> deleteGeofenceCollectionRequest)
Deletes a geofence collection from your AWS account.
|
default DeleteGeofenceCollectionResponse |
deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)
Deletes a geofence collection from your AWS account.
|
default DeleteMapResponse |
deleteMap(Consumer<DeleteMapRequest.Builder> deleteMapRequest)
Deletes a map resource from your AWS account.
|
default DeleteMapResponse |
deleteMap(DeleteMapRequest deleteMapRequest)
Deletes a map resource from your AWS account.
|
default DeletePlaceIndexResponse |
deletePlaceIndex(Consumer<DeletePlaceIndexRequest.Builder> deletePlaceIndexRequest)
Deletes a Place index resource from your AWS account.
|
default DeletePlaceIndexResponse |
deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
Deletes a Place index resource from your AWS account.
|
default DeleteTrackerResponse |
deleteTracker(Consumer<DeleteTrackerRequest.Builder> deleteTrackerRequest)
Deletes a tracker resource from your AWS account.
|
default DeleteTrackerResponse |
deleteTracker(DeleteTrackerRequest deleteTrackerRequest)
Deletes a tracker resource from your AWS account.
|
default DescribeGeofenceCollectionResponse |
describeGeofenceCollection(Consumer<DescribeGeofenceCollectionRequest.Builder> describeGeofenceCollectionRequest)
Retrieves the geofence collection details.
|
default DescribeGeofenceCollectionResponse |
describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)
Retrieves the geofence collection details.
|
default DescribeMapResponse |
describeMap(Consumer<DescribeMapRequest.Builder> describeMapRequest)
Retrieves the map resource details.
|
default DescribeMapResponse |
describeMap(DescribeMapRequest describeMapRequest)
Retrieves the map resource details.
|
default DescribePlaceIndexResponse |
describePlaceIndex(Consumer<DescribePlaceIndexRequest.Builder> describePlaceIndexRequest)
Retrieves the Place index resource details.
|
default DescribePlaceIndexResponse |
describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
Retrieves the Place index resource details.
|
default DescribeTrackerResponse |
describeTracker(Consumer<DescribeTrackerRequest.Builder> describeTrackerRequest)
Retrieves the tracker resource details.
|
default DescribeTrackerResponse |
describeTracker(DescribeTrackerRequest describeTrackerRequest)
Retrieves the tracker resource details.
|
default DisassociateTrackerConsumerResponse |
disassociateTrackerConsumer(Consumer<DisassociateTrackerConsumerRequest.Builder> disassociateTrackerConsumerRequest)
Removes the association between a tracker resource and a geofence collection.
|
default DisassociateTrackerConsumerResponse |
disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)
Removes the association between a tracker resource and a geofence collection.
|
default GetDevicePositionResponse |
getDevicePosition(Consumer<GetDevicePositionRequest.Builder> getDevicePositionRequest)
Retrieves a device's most recent position according to its sample time.
|
default GetDevicePositionResponse |
getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
Retrieves a device's most recent position according to its sample time.
|
default GetDevicePositionHistoryResponse |
getDevicePositionHistory(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
|
default GetDevicePositionHistoryResponse |
getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
|
default GetDevicePositionHistoryIterable |
getDevicePositionHistoryPaginator(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
|
default GetDevicePositionHistoryIterable |
getDevicePositionHistoryPaginator(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
|
default GetGeofenceResponse |
getGeofence(Consumer<GetGeofenceRequest.Builder> getGeofenceRequest)
Retrieves the geofence details from a geofence collection.
|
default GetGeofenceResponse |
getGeofence(GetGeofenceRequest getGeofenceRequest)
Retrieves the geofence details from a geofence collection.
|
default GetMapGlyphsResponse |
getMapGlyphs(Consumer<GetMapGlyphsRequest.Builder> getMapGlyphsRequest)
Retrieves glyphs used to display labels on a map.
|
default GetMapGlyphsResponse |
getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)
Retrieves glyphs used to display labels on a map.
|
default GetMapSpritesResponse |
getMapSprites(Consumer<GetMapSpritesRequest.Builder> getMapSpritesRequest)
Retrieves the sprite sheet corresponding to a map resource.
|
default GetMapSpritesResponse |
getMapSprites(GetMapSpritesRequest getMapSpritesRequest)
Retrieves the sprite sheet corresponding to a map resource.
|
default GetMapStyleDescriptorResponse |
getMapStyleDescriptor(Consumer<GetMapStyleDescriptorRequest.Builder> getMapStyleDescriptorRequest)
Retrieves the map style descriptor from a map resource.
|
default GetMapStyleDescriptorResponse |
getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)
Retrieves the map style descriptor from a map resource.
|
default GetMapTileResponse |
getMapTile(Consumer<GetMapTileRequest.Builder> getMapTileRequest)
Retrieves a vector data tile from the map resource.
|
default GetMapTileResponse |
getMapTile(GetMapTileRequest getMapTileRequest)
Retrieves a vector data tile from the map resource.
|
default ListGeofenceCollectionsResponse |
listGeofenceCollections(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
|
default ListGeofenceCollectionsResponse |
listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
|
default ListGeofenceCollectionsIterable |
listGeofenceCollectionsPaginator(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
|
default ListGeofenceCollectionsIterable |
listGeofenceCollectionsPaginator(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
|
default ListGeofencesResponse |
listGeofences(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest)
Lists geofences stored in a given geofence collection.
|
default ListGeofencesResponse |
listGeofences(ListGeofencesRequest listGeofencesRequest)
Lists geofences stored in a given geofence collection.
|
default ListGeofencesIterable |
listGeofencesPaginator(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest)
Lists geofences stored in a given geofence collection.
|
default ListGeofencesIterable |
listGeofencesPaginator(ListGeofencesRequest listGeofencesRequest)
Lists geofences stored in a given geofence collection.
|
default ListMapsResponse |
listMaps(Consumer<ListMapsRequest.Builder> listMapsRequest)
Lists map resources in your AWS account.
|
default ListMapsResponse |
listMaps(ListMapsRequest listMapsRequest)
Lists map resources in your AWS account.
|
default ListMapsIterable |
listMapsPaginator(Consumer<ListMapsRequest.Builder> listMapsRequest)
Lists map resources in your AWS account.
|
default ListMapsIterable |
listMapsPaginator(ListMapsRequest listMapsRequest)
Lists map resources in your AWS account.
|
default ListPlaceIndexesResponse |
listPlaceIndexes(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest)
Lists Place index resources in your AWS account.
|
default ListPlaceIndexesResponse |
listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
Lists Place index resources in your AWS account.
|
default ListPlaceIndexesIterable |
listPlaceIndexesPaginator(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest)
Lists Place index resources in your AWS account.
|
default ListPlaceIndexesIterable |
listPlaceIndexesPaginator(ListPlaceIndexesRequest listPlaceIndexesRequest)
Lists Place index resources in your AWS account.
|
default ListTrackerConsumersResponse |
listTrackerConsumers(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
|
default ListTrackerConsumersResponse |
listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
|
default ListTrackerConsumersIterable |
listTrackerConsumersPaginator(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
|
default ListTrackerConsumersIterable |
listTrackerConsumersPaginator(ListTrackerConsumersRequest listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
|
default ListTrackersResponse |
listTrackers(Consumer<ListTrackersRequest.Builder> listTrackersRequest)
Lists tracker resources in your AWS account.
|
default ListTrackersResponse |
listTrackers(ListTrackersRequest listTrackersRequest)
Lists tracker resources in your AWS account.
|
default ListTrackersIterable |
listTrackersPaginator(Consumer<ListTrackersRequest.Builder> listTrackersRequest)
Lists tracker resources in your AWS account.
|
default ListTrackersIterable |
listTrackersPaginator(ListTrackersRequest listTrackersRequest)
Lists tracker resources in your AWS account.
|
default PutGeofenceResponse |
putGeofence(Consumer<PutGeofenceRequest.Builder> putGeofenceRequest)
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a
geofence ID is included in the request.
|
default PutGeofenceResponse |
putGeofence(PutGeofenceRequest putGeofenceRequest)
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a
geofence ID is included in the request.
|
default SearchPlaceIndexForPositionResponse |
searchPlaceIndexForPosition(Consumer<SearchPlaceIndexForPositionRequest.Builder> searchPlaceIndexForPositionRequest)
Reverse geocodes a given coordinate and returns a legible address.
|
default SearchPlaceIndexForPositionResponse |
searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)
Reverse geocodes a given coordinate and returns a legible address.
|
default SearchPlaceIndexForTextResponse |
searchPlaceIndexForText(Consumer<SearchPlaceIndexForTextRequest.Builder> searchPlaceIndexForTextRequest)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of
interest.
|
default SearchPlaceIndexForTextResponse |
searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of
interest.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static LocationClient create()
LocationClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static LocationClientBuilder builder()
LocationClient
.default AssociateTrackerConsumerResponse associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
associateTrackerConsumerRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateTrackerConsumerResponse associateTrackerConsumer(Consumer<AssociateTrackerConsumerRequest.Builder> associateTrackerConsumerRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
This is a convenience which creates an instance of the AssociateTrackerConsumerRequest.Builder
avoiding
the need to create one manually via AssociateTrackerConsumerRequest.builder()
associateTrackerConsumerRequest
- A Consumer
that will call methods on AssociateTrackerConsumerRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDeleteGeofenceResponse batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a batch of geofences from a geofence collection.
This action deletes the resource permanently. You can't undo this action.
batchDeleteGeofenceRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDeleteGeofenceResponse batchDeleteGeofence(Consumer<BatchDeleteGeofenceRequest.Builder> batchDeleteGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a batch of geofences from a geofence collection.
This action deletes the resource permanently. You can't undo this action.
This is a convenience which creates an instance of the BatchDeleteGeofenceRequest.Builder
avoiding the
need to create one manually via BatchDeleteGeofenceRequest.builder()
batchDeleteGeofenceRequest
- A Consumer
that will call methods on BatchDeleteGeofenceRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchEvaluateGeofencesResponse batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Evaluates device positions against the geofence geometries from a given geofence collection. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge.
The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update
batchEvaluateGeofencesRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchEvaluateGeofencesResponse batchEvaluateGeofences(Consumer<BatchEvaluateGeofencesRequest.Builder> batchEvaluateGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Evaluates device positions against the geofence geometries from a given geofence collection. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge.
The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update
This is a convenience which creates an instance of the BatchEvaluateGeofencesRequest.Builder
avoiding the
need to create one manually via BatchEvaluateGeofencesRequest.builder()
batchEvaluateGeofencesRequest
- A Consumer
that will call methods on BatchEvaluateGeofencesRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetDevicePositionResponse batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
A batch request to retrieve all device positions.
batchGetDevicePositionRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetDevicePositionResponse batchGetDevicePosition(Consumer<BatchGetDevicePositionRequest.Builder> batchGetDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
A batch request to retrieve all device positions.
This is a convenience which creates an instance of the BatchGetDevicePositionRequest.Builder
avoiding the
need to create one manually via BatchGetDevicePositionRequest.builder()
batchGetDevicePositionRequest
- A Consumer
that will call methods on BatchGetDevicePositionRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchPutGeofenceResponse batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
A batch request for storing geofence geometries into a given geofence collection.
batchPutGeofenceRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchPutGeofenceResponse batchPutGeofence(Consumer<BatchPutGeofenceRequest.Builder> batchPutGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
A batch request for storing geofence geometries into a given geofence collection.
This is a convenience which creates an instance of the BatchPutGeofenceRequest.Builder
avoiding the need
to create one manually via BatchPutGeofenceRequest.builder()
batchPutGeofenceRequest
- A Consumer
that will call methods on BatchPutGeofenceRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchUpdateDevicePositionResponse batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history.
Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval, and retained for one year before it is deleted.
batchUpdateDevicePositionRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchUpdateDevicePositionResponse batchUpdateDevicePosition(Consumer<BatchUpdateDevicePositionRequest.Builder> batchUpdateDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when reporting the last known device position and position history.
Only one position update is stored per sample time. Location data is sampled at a fixed rate of one position per 30-second interval, and retained for one year before it is deleted.
This is a convenience which creates an instance of the BatchUpdateDevicePositionRequest.Builder
avoiding
the need to create one manually via BatchUpdateDevicePositionRequest.builder()
batchUpdateDevicePositionRequest
- A Consumer
that will call methods on BatchUpdateDevicePositionRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGeofenceCollectionResponse createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a geofence collection, which manages and stores geofences.
createGeofenceCollectionRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGeofenceCollectionResponse createGeofenceCollection(Consumer<CreateGeofenceCollectionRequest.Builder> createGeofenceCollectionRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a geofence collection, which manages and stores geofences.
This is a convenience which creates an instance of the CreateGeofenceCollectionRequest.Builder
avoiding
the need to create one manually via CreateGeofenceCollectionRequest.builder()
createGeofenceCollectionRequest
- A Consumer
that will call methods on CreateGeofenceCollectionRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateMapResponse createMap(CreateMapRequest createMapRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
By using Maps, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. For more information, see the AWS Service Terms for Amazon Location Service.
createMapRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateMapResponse createMap(Consumer<CreateMapRequest.Builder> createMapRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
By using Maps, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. For more information, see the AWS Service Terms for Amazon Location Service.
This is a convenience which creates an instance of the CreateMapRequest.Builder
avoiding the need to
create one manually via CreateMapRequest.builder()
createMapRequest
- A Consumer
that will call methods on CreateMapRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePlaceIndexResponse createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
createPlaceIndexRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePlaceIndexResponse createPlaceIndex(Consumer<CreatePlaceIndexRequest.Builder> createPlaceIndexRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
This is a convenience which creates an instance of the CreatePlaceIndexRequest.Builder
avoiding the need
to create one manually via CreatePlaceIndexRequest.builder()
createPlaceIndexRequest
- A Consumer
that will call methods on CreatePlaceIndexRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateTrackerResponse createTracker(CreateTrackerRequest createTrackerRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
createTrackerRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateTrackerResponse createTracker(Consumer<CreateTrackerRequest.Builder> createTrackerRequest) throws InternalServerException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
This is a convenience which creates an instance of the CreateTrackerRequest.Builder
avoiding the need to
create one manually via CreateTrackerRequest.builder()
createTrackerRequest
- A Consumer
that will call methods on CreateTrackerRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGeofenceCollectionResponse deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a geofence collection from your AWS account.
This action deletes the resource permanently. You can't undo this action. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
deleteGeofenceCollectionRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGeofenceCollectionResponse deleteGeofenceCollection(Consumer<DeleteGeofenceCollectionRequest.Builder> deleteGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a geofence collection from your AWS account.
This action deletes the resource permanently. You can't undo this action. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
This is a convenience which creates an instance of the DeleteGeofenceCollectionRequest.Builder
avoiding
the need to create one manually via DeleteGeofenceCollectionRequest.builder()
deleteGeofenceCollectionRequest
- A Consumer
that will call methods on DeleteGeofenceCollectionRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteMapResponse deleteMap(DeleteMapRequest deleteMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a map resource from your AWS account.
This action deletes the resource permanently. You cannot undo this action. If the map is being used in an application, the map may not render.
deleteMapRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteMapResponse deleteMap(Consumer<DeleteMapRequest.Builder> deleteMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a map resource from your AWS account.
This action deletes the resource permanently. You cannot undo this action. If the map is being used in an application, the map may not render.
This is a convenience which creates an instance of the DeleteMapRequest.Builder
avoiding the need to
create one manually via DeleteMapRequest.builder()
deleteMapRequest
- A Consumer
that will call methods on DeleteMapRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePlaceIndexResponse deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a Place index resource from your AWS account.
This action deletes the resource permanently. You cannot undo this action.
deletePlaceIndexRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePlaceIndexResponse deletePlaceIndex(Consumer<DeletePlaceIndexRequest.Builder> deletePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a Place index resource from your AWS account.
This action deletes the resource permanently. You cannot undo this action.
This is a convenience which creates an instance of the DeletePlaceIndexRequest.Builder
avoiding the need
to create one manually via DeletePlaceIndexRequest.builder()
deletePlaceIndexRequest
- A Consumer
that will call methods on DeletePlaceIndexRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTrackerResponse deleteTracker(DeleteTrackerRequest deleteTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a tracker resource from your AWS account.
This action deletes the resource permanently. You can't undo this action. If the tracker resource is in use, you may encounter an error. Make sure that the target resource is not a dependency for your applications.
deleteTrackerRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTrackerResponse deleteTracker(Consumer<DeleteTrackerRequest.Builder> deleteTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Deletes a tracker resource from your AWS account.
This action deletes the resource permanently. You can't undo this action. If the tracker resource is in use, you may encounter an error. Make sure that the target resource is not a dependency for your applications.
This is a convenience which creates an instance of the DeleteTrackerRequest.Builder
avoiding the need to
create one manually via DeleteTrackerRequest.builder()
deleteTrackerRequest
- A Consumer
that will call methods on DeleteTrackerRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeGeofenceCollectionResponse describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the geofence collection details.
describeGeofenceCollectionRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeGeofenceCollectionResponse describeGeofenceCollection(Consumer<DescribeGeofenceCollectionRequest.Builder> describeGeofenceCollectionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the geofence collection details.
This is a convenience which creates an instance of the DescribeGeofenceCollectionRequest.Builder
avoiding
the need to create one manually via DescribeGeofenceCollectionRequest.builder()
describeGeofenceCollectionRequest
- A Consumer
that will call methods on DescribeGeofenceCollectionRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeMapResponse describeMap(DescribeMapRequest describeMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the map resource details.
describeMapRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeMapResponse describeMap(Consumer<DescribeMapRequest.Builder> describeMapRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the map resource details.
This is a convenience which creates an instance of the DescribeMapRequest.Builder
avoiding the need to
create one manually via DescribeMapRequest.builder()
describeMapRequest
- A Consumer
that will call methods on DescribeMapRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribePlaceIndexResponse describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the Place index resource details.
describePlaceIndexRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribePlaceIndexResponse describePlaceIndex(Consumer<DescribePlaceIndexRequest.Builder> describePlaceIndexRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the Place index resource details.
This is a convenience which creates an instance of the DescribePlaceIndexRequest.Builder
avoiding the
need to create one manually via DescribePlaceIndexRequest.builder()
describePlaceIndexRequest
- A Consumer
that will call methods on DescribePlaceIndexRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrackerResponse describeTracker(DescribeTrackerRequest describeTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the tracker resource details.
describeTrackerRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrackerResponse describeTracker(Consumer<DescribeTrackerRequest.Builder> describeTrackerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the tracker resource details.
This is a convenience which creates an instance of the DescribeTrackerRequest.Builder
avoiding the need
to create one manually via DescribeTrackerRequest.builder()
describeTrackerRequest
- A Consumer
that will call methods on DescribeTrackerRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateTrackerConsumerResponse disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Removes the association between a tracker resource and a geofence collection.
Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
disassociateTrackerConsumerRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateTrackerConsumerResponse disassociateTrackerConsumer(Consumer<DisassociateTrackerConsumerRequest.Builder> disassociateTrackerConsumerRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Removes the association between a tracker resource and a geofence collection.
Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
This is a convenience which creates an instance of the DisassociateTrackerConsumerRequest.Builder
avoiding the need to create one manually via DisassociateTrackerConsumerRequest.builder()
disassociateTrackerConsumerRequest
- A Consumer
that will call methods on DisassociateTrackerConsumerRequest.Builder
to create
a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDevicePositionResponse getDevicePosition(GetDevicePositionRequest getDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after one year.
getDevicePositionRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDevicePositionResponse getDevicePosition(Consumer<GetDevicePositionRequest.Builder> getDevicePositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after one year.
This is a convenience which creates an instance of the GetDevicePositionRequest.Builder
avoiding the need
to create one manually via GetDevicePositionRequest.builder()
getDevicePositionRequest
- A Consumer
that will call methods on GetDevicePositionRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDevicePositionHistoryResponse getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 1 year.
getDevicePositionHistoryRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDevicePositionHistoryResponse getDevicePositionHistory(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 1 year.
This is a convenience which creates an instance of the GetDevicePositionHistoryRequest.Builder
avoiding
the need to create one manually via GetDevicePositionHistoryRequest.builder()
getDevicePositionHistoryRequest
- A Consumer
that will call methods on GetDevicePositionHistoryRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDevicePositionHistoryIterable getDevicePositionHistoryPaginator(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 1 year.
This is a variant of
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client.getDevicePositionHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation.
getDevicePositionHistoryRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDevicePositionHistoryIterable getDevicePositionHistoryPaginator(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 1 year.
This is a variant of
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryIterable responses = client.getDevicePositionHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation.
This is a convenience which creates an instance of the GetDevicePositionHistoryRequest.Builder
avoiding
the need to create one manually via GetDevicePositionHistoryRequest.builder()
getDevicePositionHistoryRequest
- A Consumer
that will call methods on GetDevicePositionHistoryRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGeofenceResponse getGeofence(GetGeofenceRequest getGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the geofence details from a geofence collection.
getGeofenceRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGeofenceResponse getGeofence(Consumer<GetGeofenceRequest.Builder> getGeofenceRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the geofence details from a geofence collection.
This is a convenience which creates an instance of the GetGeofenceRequest.Builder
avoiding the need to
create one manually via GetGeofenceRequest.builder()
getGeofenceRequest
- A Consumer
that will call methods on GetGeofenceRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMapGlyphsResponse getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves glyphs used to display labels on a map.
getMapGlyphsRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMapGlyphsResponse getMapGlyphs(Consumer<GetMapGlyphsRequest.Builder> getMapGlyphsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves glyphs used to display labels on a map.
This is a convenience which creates an instance of the GetMapGlyphsRequest.Builder
avoiding the need to
create one manually via GetMapGlyphsRequest.builder()
getMapGlyphsRequest
- A Consumer
that will call methods on GetMapGlyphsRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMapSpritesResponse getMapSprites(GetMapSpritesRequest getMapSpritesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
getMapSpritesRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMapSpritesResponse getMapSprites(Consumer<GetMapSpritesRequest.Builder> getMapSpritesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
This is a convenience which creates an instance of the GetMapSpritesRequest.Builder
avoiding the need to
create one manually via GetMapSpritesRequest.builder()
getMapSpritesRequest
- A Consumer
that will call methods on GetMapSpritesRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMapStyleDescriptorResponse getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
getMapStyleDescriptorRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMapStyleDescriptorResponse getMapStyleDescriptor(Consumer<GetMapStyleDescriptorRequest.Builder> getMapStyleDescriptorRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
This is a convenience which creates an instance of the GetMapStyleDescriptorRequest.Builder
avoiding the
need to create one manually via GetMapStyleDescriptorRequest.builder()
getMapStyleDescriptorRequest
- A Consumer
that will call methods on GetMapStyleDescriptorRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMapTileResponse getMapTile(GetMapTileRequest getMapTileRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. They are 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).
getMapTileRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMapTileResponse getMapTile(Consumer<GetMapTileRequest.Builder> getMapTileRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. They are addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
This is a convenience which creates an instance of the GetMapTileRequest.Builder
avoiding the need to
create one manually via GetMapTileRequest.builder()
getMapTileRequest
- A Consumer
that will call methods on GetMapTileRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGeofenceCollectionsResponse listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections in your AWS account.
listGeofenceCollectionsRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGeofenceCollectionsResponse listGeofenceCollections(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections in your AWS account.
This is a convenience which creates an instance of the ListGeofenceCollectionsRequest.Builder
avoiding
the need to create one manually via ListGeofenceCollectionsRequest.builder()
listGeofenceCollectionsRequest
- A Consumer
that will call methods on ListGeofenceCollectionsRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGeofenceCollectionsIterable listGeofenceCollectionsPaginator(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections in your AWS account.
This is a variant of
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation.
listGeofenceCollectionsRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGeofenceCollectionsIterable listGeofenceCollectionsPaginator(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections in your AWS account.
This is a variant of
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation.
This is a convenience which creates an instance of the ListGeofenceCollectionsRequest.Builder
avoiding
the need to create one manually via ListGeofenceCollectionsRequest.builder()
listGeofenceCollectionsRequest
- A Consumer
that will call methods on ListGeofenceCollectionsRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGeofencesResponse listGeofences(ListGeofencesRequest listGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofences stored in a given geofence collection.
listGeofencesRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGeofencesResponse listGeofences(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofences stored in a given geofence collection.
This is a convenience which creates an instance of the ListGeofencesRequest.Builder
avoiding the need to
create one manually via ListGeofencesRequest.builder()
listGeofencesRequest
- A Consumer
that will call methods on ListGeofencesRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGeofencesIterable listGeofencesPaginator(ListGeofencesRequest listGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofences stored in a given geofence collection.
This is a variant of listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
software.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation.
listGeofencesRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGeofencesIterable listGeofencesPaginator(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofences stored in a given geofence collection.
This is a variant of listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
software.amazon.awssdk.services.location.paginators.ListGeofencesIterable responses = client.listGeofencesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation.
This is a convenience which creates an instance of the ListGeofencesRequest.Builder
avoiding the need to
create one manually via ListGeofencesRequest.builder()
listGeofencesRequest
- A Consumer
that will call methods on ListGeofencesRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMapsResponse listMaps(ListMapsRequest listMapsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists map resources in your AWS account.
listMapsRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMapsResponse listMaps(Consumer<ListMapsRequest.Builder> listMapsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists map resources in your AWS account.
This is a convenience which creates an instance of the ListMapsRequest.Builder
avoiding the need to
create one manually via ListMapsRequest.builder()
listMapsRequest
- A Consumer
that will call methods on ListMapsRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMapsIterable listMapsPaginator(ListMapsRequest listMapsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists map resources in your AWS account.
This is a variant of listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation.
listMapsRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMapsIterable listMapsPaginator(Consumer<ListMapsRequest.Builder> listMapsRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists map resources in your AWS account.
This is a variant of listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest)
operation.
This is a convenience which creates an instance of the ListMapsRequest.Builder
avoiding the need to
create one manually via ListMapsRequest.builder()
listMapsRequest
- A Consumer
that will call methods on ListMapsRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPlaceIndexesResponse listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists Place index resources in your AWS account.
listPlaceIndexesRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPlaceIndexesResponse listPlaceIndexes(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists Place index resources in your AWS account.
This is a convenience which creates an instance of the ListPlaceIndexesRequest.Builder
avoiding the need
to create one manually via ListPlaceIndexesRequest.builder()
listPlaceIndexesRequest
- A Consumer
that will call methods on ListPlaceIndexesRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPlaceIndexesIterable listPlaceIndexesPaginator(ListPlaceIndexesRequest listPlaceIndexesRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists Place index resources in your AWS account.
This is a variant of
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation.
listPlaceIndexesRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPlaceIndexesIterable listPlaceIndexesPaginator(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists Place index resources in your AWS account.
This is a variant of
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest)
operation.
This is a convenience which creates an instance of the ListPlaceIndexesRequest.Builder
avoiding the need
to create one manually via ListPlaceIndexesRequest.builder()
listPlaceIndexesRequest
- A Consumer
that will call methods on ListPlaceIndexesRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrackerConsumersResponse listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections currently associated to the given tracker resource.
listTrackerConsumersRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrackerConsumersResponse listTrackerConsumers(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections currently associated to the given tracker resource.
This is a convenience which creates an instance of the ListTrackerConsumersRequest.Builder
avoiding the
need to create one manually via ListTrackerConsumersRequest.builder()
listTrackerConsumersRequest
- A Consumer
that will call methods on ListTrackerConsumersRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrackerConsumersIterable listTrackerConsumersPaginator(ListTrackerConsumersRequest listTrackerConsumersRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections currently associated to the given tracker resource.
This is a variant of
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation.
listTrackerConsumersRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrackerConsumersIterable listTrackerConsumersPaginator(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists geofence collections currently associated to the given tracker resource.
This is a variant of
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation.
This is a convenience which creates an instance of the ListTrackerConsumersRequest.Builder
avoiding the
need to create one manually via ListTrackerConsumersRequest.builder()
listTrackerConsumersRequest
- A Consumer
that will call methods on ListTrackerConsumersRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrackersResponse listTrackers(ListTrackersRequest listTrackersRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists tracker resources in your AWS account.
listTrackersRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrackersResponse listTrackers(Consumer<ListTrackersRequest.Builder> listTrackersRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists tracker resources in your AWS account.
This is a convenience which creates an instance of the ListTrackersRequest.Builder
avoiding the need to
create one manually via ListTrackersRequest.builder()
listTrackersRequest
- A Consumer
that will call methods on ListTrackersRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrackersIterable listTrackersPaginator(ListTrackersRequest listTrackersRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists tracker resources in your AWS account.
This is a variant of listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation.
listTrackersRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrackersIterable listTrackersPaginator(Consumer<ListTrackersRequest.Builder> listTrackersRequest) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Lists tracker resources in your AWS account.
This is a variant of listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
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
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
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation.
This is a convenience which creates an instance of the ListTrackersRequest.Builder
avoiding the need to
create one manually via ListTrackersRequest.builder()
listTrackersRequest
- A Consumer
that will call methods on ListTrackersRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutGeofenceResponse putGeofence(PutGeofenceRequest putGeofenceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
putGeofenceRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutGeofenceResponse putGeofence(Consumer<PutGeofenceRequest.Builder> putGeofenceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
This is a convenience which creates an instance of the PutGeofenceRequest.Builder
avoiding the need to
create one manually via PutGeofenceRequest.builder()
putGeofenceRequest
- A Consumer
that will call methods on PutGeofenceRequest.Builder
to create a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.ConflictException
- The request was unsuccessful due to a conflict.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchPlaceIndexForPositionResponse searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
searchPlaceIndexForPositionRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchPlaceIndexForPositionResponse searchPlaceIndexForPosition(Consumer<SearchPlaceIndexForPositionRequest.Builder> searchPlaceIndexForPositionRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
This is a convenience which creates an instance of the SearchPlaceIndexForPositionRequest.Builder
avoiding the need to create one manually via SearchPlaceIndexForPositionRequest.builder()
searchPlaceIndexForPositionRequest
- A Consumer
that will call methods on SearchPlaceIndexForPositionRequest.Builder
to create
a request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchPlaceIndexForTextResponse searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Includes the option to apply additional parameters to narrow your list of results.
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.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select
the Storage
option for the IntendedUse
parameter when requesting Places in Japan. For
more information, see the AWS Service Terms for Amazon
Location Service.
searchPlaceIndexForTextRequest
- InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchPlaceIndexForTextResponse searchPlaceIndexForText(Consumer<SearchPlaceIndexForTextRequest.Builder> searchPlaceIndexForTextRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, LocationException
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Includes the option to apply additional parameters to narrow your list of results.
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.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select
the Storage
option for the IntendedUse
parameter when requesting Places in Japan. For
more information, see the AWS Service Terms for Amazon
Location Service.
This is a convenience which creates an instance of the SearchPlaceIndexForTextRequest.Builder
avoiding
the need to create one manually via SearchPlaceIndexForTextRequest.builder()
searchPlaceIndexForTextRequest
- A Consumer
that will call methods on SearchPlaceIndexForTextRequest.Builder
to create a
request.InternalServerException
- The request has failed to process because of an unknown server error, exception, or failure.ResourceNotFoundException
- The resource that you've entered was not found in your AWS account.AccessDeniedException
- The request was denied due to insufficient access or permission. Check with an administrator to verify
your permissions.ValidationException
- The input failed to meet the constraints specified by the AWS service.ThrottlingException
- The request was denied due to request throttling.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LocationException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()