See: newCalculateRoute smart constructor.

Create a value of CalculateRoute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:carModeOptions:CalculateRoute', calculateRoute_carModeOptions - Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

$sel:departNow:CalculateRoute', calculateRoute_departNow - Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

$sel:departureTime:CalculateRoute', calculateRoute_departureTime - Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

CalculateRoute, calculateRoute_distanceUnit - Set the unit system to specify the distance.

Default Value: Kilometers

$sel:includeLegGeometry:CalculateRoute', calculateRoute_includeLegGeometry - Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

$sel:travelMode:CalculateRoute', calculateRoute_travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.
• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

$sel:truckModeOptions:CalculateRoute', calculateRoute_truckModeOptions - Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

$sel:waypointPositions:CalculateRoute', calculateRoute_waypointPositions - Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

CalculateRoute, calculateRoute_calculatorName - The name of the route calculator resource that you want to use to calculate the route.

$sel:departurePosition:CalculateRoute', calculateRoute_departurePosition - The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

$sel:destinationPosition:CalculateRoute', calculateRoute_destinationPosition - The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Set the unit system to specify the distance.

Default Value: Kilometers

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.
• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

The name of the route calculator resource that you want to use to calculate the route.

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Returns the result of the route calculation. Metadata includes legs and route summary.

See: newCalculateRouteResponse smart constructor.

Create a value of CalculateRouteResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CalculateRouteResponse', calculateRouteResponse_httpStatus - The response's http status code.

$sel:legs:CalculateRouteResponse', calculateRouteResponse_legs - Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

• The StartPosition is the departure position.
• The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

• Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
• Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

$sel:summary:CalculateRouteResponse', calculateRouteResponse_summary - Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

The response's http status code.

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

• The StartPosition is the departure position.
• The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

• Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
• Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.