Post v2routes — geo-routes

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-145615375.2 KB

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

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

post/v2/routes

Query parameters

keystring password

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Request body

ArrivalTimestring password

Time of arrival at the destination. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> Examples: <code>2020-04-22T17:57:24Z</code> <code>2020-04-22T17:57:24+02:00</code>

DepartNowboolean

Uses the current time as the time of departure.

DepartureTimestring password

Time of departure from the origin. Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> Examples: <code>2020-04-22T17:57:24Z</code> <code>2020-04-22T17:57:24+02:00</code>

DestinationDouble[] required

The final position for the route. In the World Geodetic System (WGS 84) format: <code>[longitude, latitude]</code>.

InstructionsMeasurementSystem'Metric' | 'Imperial'

Measurement system to be used for instructions within steps in the response.

LanguagesLanguageTag[]

List of languages for instructions within steps in the response. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. <note> Instructions in the requested language are returned only if they are available. </note>

LegAdditionalFeaturesRouteLegAdditionalFeature[]

A list of optional additional parameters such as timezone that can be requested for each result. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>PassThroughWaypoints</code>, <code>Summary</code>, and <code>TravelStepInstructions</code> <ul> <li> <code>Elevation</code>: Retrieves the elevation information for each location. </li> <li> <code>Incidents</code>: Provides information on traffic incidents along the route. </li> <li> <code>PassThroughWaypoints</code>: Indicates waypoints that are passed through without stopping. </li> <li> <code>Summary</code>: Returns a summary of the route, including distance and duration. </li> <li> <code>Tolls</code>: Supplies toll cost information along the route. </li> <li> <code>TravelStepInstructions</code>: Provides step-by-step instructions for travel along the route. </li> <li> <code>TruckRoadTypes</code>: Returns information about road types suitable for trucks. </li> <li> <code>TypicalDuration</code>: Gives typical travel duration based on historical data. </li> <li> <code>Zones</code>: Specifies the time zone information for each waypoint. </li> </ul>

LegGeometryFormat'FlexiblePolyline' | 'Simple'

Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats. <code>FlexiblePolyline</code>: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for <a href="https://github.com/aws-geospatial/polyline">https://github.com/aws-geospatial/polyline</a>. <code>Simple</code>: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

MaxAlternativesinteger

Maximum number of alternative routes to be provided in the response, if available. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only up to 3 alternative routes.

OptimizeRoutingFor'FastestRoute' | 'ShortestRoute'

Controls the trade-off between achieving the shortest travel time (<code>FastestRoute</code>) and achieving the shortest physical distance ((<code>ShortestRoute</code>) when calculating each route in the matrix. Default value: <code>FastestRoute</code>

OriginDouble[] required

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

SpanAdditionalFeaturesRouteSpanAdditionalFeature[]

A list of optional features such as <code>SpeedLimit</code> that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>Car</code>, <code>Pedestrian</code>, and <code>Scooter</code> values. Default value: <code>Car</code>

TravelStepType'Default' | 'TurnByTurn'

Type of step returned by the response. <code>Default</code> provides basic steps intended for web based applications. <code>TurnByTurn</code> provides detailed instructions with more granularity intended for a turn based navigation system. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions <code>Default</code> does not return any steps.

Response

Success

LegGeometryFormat'FlexiblePolyline' | 'Simple' required

Specifies the format of the geometry returned for each leg of the route.