Interface GeoRoutesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@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 Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information. Key features include:

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

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

• Route matrices for efficient multi-destination planning. See CalculateRouteMatrix.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final 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)	Calculates areas that can be reached within specified time or distance thresholds from a given point.
default CalculateIsolinesResponse	calculateIsolines(CalculateIsolinesRequest calculateIsolinesRequest)	Calculates areas that can be reached within specified time or distance thresholds from a given point.
default CalculateRouteMatrixResponse	calculateRouteMatrix(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest)	Use CalculateRouteMatrix to compute results for all pairs of Origins to Destinations.
default CalculateRouteMatrixResponse	calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)	Use CalculateRouteMatrix to compute results for all pairs of Origins to Destinations.
default CalculateRoutesResponse	calculateRoutes(Consumer<CalculateRoutesRequest.Builder> calculateRoutesRequest)	CalculateRoutes computes routes given the following required parameters: Origin and Destination.
default CalculateRoutesResponse	calculateRoutes(CalculateRoutesRequest calculateRoutesRequest)	CalculateRoutes computes routes 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)	OptimizeWaypoints 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)	OptimizeWaypoints 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()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default SnapToRoadsResponse	snapToRoads(Consumer<SnapToRoadsRequest.Builder> snapToRoadsRequest)	SnapToRoads matches GPS trace to roads most likely traveled on.
default SnapToRoadsResponse	snapToRoads(SnapToRoadsRequest snapToRoadsRequest)	SnapToRoads 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 Details

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 Details

calculateIsolines

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

Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time.

Isolines (also known as isochrones for time-based calculations) are useful for various applications including:

• Service area visualization - Show customers the area you can serve within promised delivery times

• Site selection - Analyze potential business locations based on population within travel distance

• Site selection - Determine areas that can be reached within specified response times

Route preferences such as avoiding toll roads or ferries are treated as preferences rather than absolute restrictions. If a viable route cannot be calculated while honoring all preferences, some may be ignored.

For more information, see Calculate isolines in the Amazon Location Service Developer Guide.

Parameters:

calculateIsolinesRequest -

Returns:

Result of the CalculateIsolines operation returned by the service.

See Also:

• AWS API Documentation

calculateIsolines

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

Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time.

Isolines (also known as isochrones for time-based calculations) are useful for various applications including:

• Service area visualization - Show customers the area you can serve within promised delivery times

• Site selection - Analyze potential business locations based on population within travel distance

• Site selection - Determine areas that can be reached within specified response times

Route preferences such as avoiding toll roads or ferries are treated as preferences rather than absolute restrictions. If a viable route cannot be calculated while honoring all preferences, some may be ignored.

For more information, see Calculate isolines in the Amazon Location Service Developer Guide.

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.

See Also:

• AWS API Documentation

calculateRouteMatrix

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

Use CalculateRouteMatrix to compute 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.

For more information, see Calculate route matrix in the Amazon Location Service Developer Guide.

Parameters:

calculateRouteMatrixRequest -

Returns:

Result of the CalculateRouteMatrix operation returned by the service.

See Also:

• AWS API Documentation

calculateRouteMatrix

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

Use CalculateRouteMatrix to compute 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.

For more information, see Calculate route matrix in the Amazon Location Service Developer Guide.

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.

See Also:

• AWS API Documentation

calculateRoutes

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

CalculateRoutes computes routes given the following required parameters: Origin and Destination.

For more information, see Calculate routes in the Amazon Location Service Developer Guide.

Parameters:

calculateRoutesRequest -

Returns:

Result of the CalculateRoutes operation returned by the service.

See Also:

• AWS API Documentation

calculateRoutes

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

CalculateRoutes computes routes given the following required parameters: Origin and Destination.

For more information, see Calculate routes in the Amazon Location Service Developer Guide.

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.

See Also:

• AWS API Documentation

optimizeWaypoints

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

OptimizeWaypoints 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.

For more information, see Optimize waypoints in the Amazon Location Service Developer Guide.

Parameters:

optimizeWaypointsRequest -

Returns:

Result of the OptimizeWaypoints operation returned by the service.

See Also:

• AWS API Documentation

optimizeWaypoints

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

OptimizeWaypoints 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.

For more information, see Optimize waypoints in the Amazon Location Service Developer Guide.

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.

See Also:

• AWS API Documentation

snapToRoads

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

SnapToRoads matches GPS trace to roads most likely traveled on.

For more information, see Snap to Roads in the Amazon Location Service Developer Guide.

Parameters:

snapToRoadsRequest -

Returns:

Result of the SnapToRoads operation returned by the service.

See Also:

• AWS API Documentation

snapToRoads

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

SnapToRoads matches GPS trace to roads most likely traveled on.

For more information, see Snap to Roads in the Amazon Location Service Developer Guide.

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.

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()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration