georoutes/aws.sdk.kotlin.services.georoutes/GeoRoutesClient

GeoRoutesClient

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

Types

Builder

class Builder : AbstractSdkClientBuilder<GeoRoutesClient.Config, GeoRoutesClient.Config.Builder, GeoRoutesClient>

Companion

object Companion : AbstractAwsSdkClientFactory<GeoRoutesClient.Config, GeoRoutesClient.Config.Builder, GeoRoutesClient, GeoRoutesClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: GeoRoutesClient.Config

GeoRoutesClient's configuration

Functions

calculateIsolines

abstract suspend fun calculateIsolines(input: CalculateIsolinesRequest): CalculateIsolinesResponse

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

calculateRouteMatrix

abstract suspend fun calculateRouteMatrix(input: CalculateRouteMatrixRequest): CalculateRouteMatrixResponse

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.

calculateRoutes

abstract suspend fun calculateRoutes(input: CalculateRoutesRequest): CalculateRoutesResponse

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

optimizeWaypoints

abstract suspend fun optimizeWaypoints(input: OptimizeWaypointsRequest): OptimizeWaypointsResponse

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.

snapToRoads

abstract suspend fun snapToRoads(input: SnapToRoadsRequest): SnapToRoadsResponse

SnapToRoads matches GPS trace to roads most likely traveled on.

Inherited functions

calculateIsolines

inline suspend fun GeoRoutesClient.calculateIsolines(crossinline block: CalculateIsolinesRequest.Builder.() -> Unit): CalculateIsolinesResponse

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

calculateRouteMatrix

inline suspend fun GeoRoutesClient.calculateRouteMatrix(crossinline block: CalculateRouteMatrixRequest.Builder.() -> Unit): CalculateRouteMatrixResponse

calculateRoutes

inline suspend fun GeoRoutesClient.calculateRoutes(crossinline block: CalculateRoutesRequest.Builder.() -> Unit): CalculateRoutesResponse

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

expect abstract fun close()

optimizeWaypoints

inline suspend fun GeoRoutesClient.optimizeWaypoints(crossinline block: OptimizeWaypointsRequest.Builder.() -> Unit): OptimizeWaypointsResponse

snapToRoads

inline suspend fun GeoRoutesClient.snapToRoads(crossinline block: SnapToRoadsRequest.Builder.() -> Unit): SnapToRoadsResponse

SnapToRoads matches GPS trace to roads most likely traveled on.

withConfig

fun GeoRoutesClient.withConfig(block: GeoRoutesClient.Config.Builder.() -> Unit): GeoRoutesClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.