Package software.amazon.awssdk.services.georoutes

Interface GeoRoutesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface GeoRoutesClient
extends AwsClient

Service client for accessing Amazon Location Service Routes V2. This can be created using the static builder() method.

With the Amazon Location Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information.

Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:

• Point-to-point routing with estimated travel time, distance, and turn-by-turn directions

• Multi-point route optimization to minimize travel time or distance

• Route matrices for efficient multi-destination planning

• Isoline calculations to determine reachable areas within specified time or distance thresholds

• Map-matching to align GPS traces with the road network

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static GeoRoutesClientBuilder	builder()	Create a builder that can be used to configure and create a GeoRoutesClient.
default CalculateIsolinesResponse	calculateIsolines(Consumer<CalculateIsolinesRequest.Builder> calculateIsolinesRequest)	Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.
default CalculateIsolinesResponse	calculateIsolines(CalculateIsolinesRequest calculateIsolinesRequest)	Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.
default CalculateRouteMatrixResponse	calculateRouteMatrix(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest)	Calculates route matrix containing the results for all pairs of Origins to Destinations.
default CalculateRouteMatrixResponse	calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)	Calculates route matrix containing the results for all pairs of Origins to Destinations.
default CalculateRoutesResponse	calculateRoutes(Consumer<CalculateRoutesRequest.Builder> calculateRoutesRequest)	Calculates a route given the following required parameters: Origin and Destination.
default CalculateRoutesResponse	calculateRoutes(CalculateRoutesRequest calculateRoutesRequest)	Calculates a route given the following required parameters: Origin and Destination.
static GeoRoutesClient	create()	Create a GeoRoutesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default OptimizeWaypointsResponse	optimizeWaypoints(Consumer<OptimizeWaypointsRequest.Builder> optimizeWaypointsRequest)	Calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.
default OptimizeWaypointsResponse	optimizeWaypoints(OptimizeWaypointsRequest optimizeWaypointsRequest)	Calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.
default GeoRoutesServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default SnapToRoadsResponse	snapToRoads(Consumer<SnapToRoadsRequest.Builder> snapToRoadsRequest)	The SnapToRoads action matches GPS trace to roads most likely traveled on.
default SnapToRoadsResponse	snapToRoads(SnapToRoadsRequest snapToRoadsRequest)	The SnapToRoads action matches GPS trace to roads most likely traveled on.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

calculateIsolines

default CalculateIsolinesResponse calculateIsolines(CalculateIsolinesRequest calculateIsolinesRequest)
                                             throws InternalServerException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    GeoRoutesException

Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.

Parameters:

calculateIsolinesRequest -

Returns:

Result of the CalculateIsolines operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

calculateIsolines

default CalculateIsolinesResponse calculateIsolines(Consumer<CalculateIsolinesRequest.Builder> calculateIsolinesRequest)
                                             throws InternalServerException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    GeoRoutesException

Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.

This is a convenience which creates an instance of the CalculateIsolinesRequest.Builder avoiding the need to create one manually via CalculateIsolinesRequest.builder()

Parameters:

calculateIsolinesRequest - A Consumer that will call methods on CalculateIsolinesRequest.Builder to create a request.

Returns:

Result of the CalculateIsolines operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

calculateRouteMatrix

default CalculateRouteMatrixResponse calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)
                                                   throws InternalServerException,
                                                          AccessDeniedException,
                                                          ValidationException,
                                                          ThrottlingException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          GeoRoutesException

Calculates route matrix containing the results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.

Parameters:

calculateRouteMatrixRequest -

Returns:

Result of the CalculateRouteMatrix operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

calculateRouteMatrix

default CalculateRouteMatrixResponse calculateRouteMatrix(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest)
                                                   throws InternalServerException,
                                                          AccessDeniedException,
                                                          ValidationException,
                                                          ThrottlingException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          GeoRoutesException

Calculates route matrix containing the results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.

This is a convenience which creates an instance of the CalculateRouteMatrixRequest.Builder avoiding the need to create one manually via CalculateRouteMatrixRequest.builder()

Parameters:

calculateRouteMatrixRequest - A Consumer that will call methods on CalculateRouteMatrixRequest.Builder to create a request.

Returns:

Result of the CalculateRouteMatrix operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

calculateRoutes

default CalculateRoutesResponse calculateRoutes(CalculateRoutesRequest calculateRoutesRequest)
                                         throws InternalServerException,
                                                AccessDeniedException,
                                                ValidationException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                GeoRoutesException

Calculates a route given the following required parameters: Origin and Destination.

Parameters:

calculateRoutesRequest -

Returns:

Result of the CalculateRoutes operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

calculateRoutes

default CalculateRoutesResponse calculateRoutes(Consumer<CalculateRoutesRequest.Builder> calculateRoutesRequest)
                                         throws InternalServerException,
                                                AccessDeniedException,
                                                ValidationException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                GeoRoutesException

Calculates a route given the following required parameters: Origin and Destination.

This is a convenience which creates an instance of the CalculateRoutesRequest.Builder avoiding the need to create one manually via CalculateRoutesRequest.builder()

Parameters:

calculateRoutesRequest - A Consumer that will call methods on CalculateRoutesRequest.Builder to create a request.

Returns:

Result of the CalculateRoutes operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

optimizeWaypoints

default OptimizeWaypointsResponse optimizeWaypoints(OptimizeWaypointsRequest optimizeWaypointsRequest)
                                             throws InternalServerException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    GeoRoutesException

Calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.

Parameters:

optimizeWaypointsRequest -

Returns:

Result of the OptimizeWaypoints operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

optimizeWaypoints

default OptimizeWaypointsResponse optimizeWaypoints(Consumer<OptimizeWaypointsRequest.Builder> optimizeWaypointsRequest)
                                             throws InternalServerException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    GeoRoutesException

Calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.

This is a convenience which creates an instance of the OptimizeWaypointsRequest.Builder avoiding the need to create one manually via OptimizeWaypointsRequest.builder()

Parameters:

optimizeWaypointsRequest - A Consumer that will call methods on OptimizeWaypointsRequest.Builder to create a request.

Returns:

Result of the OptimizeWaypoints operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

snapToRoads

default SnapToRoadsResponse snapToRoads(SnapToRoadsRequest snapToRoadsRequest)
                                 throws InternalServerException,
                                        AccessDeniedException,
                                        ValidationException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        GeoRoutesException

The SnapToRoads action matches GPS trace to roads most likely traveled on.

Parameters:

snapToRoadsRequest -

Returns:

Result of the SnapToRoads operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

snapToRoads

default SnapToRoadsResponse snapToRoads(Consumer<SnapToRoadsRequest.Builder> snapToRoadsRequest)
                                 throws InternalServerException,
                                        AccessDeniedException,
                                        ValidationException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        GeoRoutesException

The SnapToRoads action matches GPS trace to roads most likely traveled on.

This is a convenience which creates an instance of the SnapToRoadsRequest.Builder avoiding the need to create one manually via SnapToRoadsRequest.builder()

Parameters:

snapToRoadsRequest - A Consumer that will call methods on SnapToRoadsRequest.Builder to create a request.

Returns:

Result of the SnapToRoads operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an 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.

GeoRoutesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static GeoRoutesClient create()

Create a GeoRoutesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static GeoRoutesClientBuilder builder()

Create a builder that can be used to configure and create a GeoRoutesClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default GeoRoutesServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient