Own AWS? Customize your docs with AI search, analytics, and more.

POST

/routes/v0/calculators/{CalculatorName}/calculate/route

http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route

<a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters: <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a route calculator resource</a>. By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route. Additional options include: <ul> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code> or <code>DepartNow</code>. This calculates a route based on predictive traffic data at the given time. <note> You can't specify both <code>DepartureTime</code> and <code>DepartNow</code> in a single request. Specifying both parameters returns a validation error. </note> </li> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or <code>TruckModeOptions</code> if traveling by <code>Truck</code>. <note> If you specify <code>walking</code> for the travel mode and your data provider is Esri, the start and destination must be within 40km. </note> </li> </ul>

Access Token Required: API Key

Path Parameters

CalculatorNamestringrequired

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

Body Params

DepartNowboolean

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: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

TravelModestring

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose <code>Car</code>, <code>Truck</code>, <code>Walking</code>, <code>Bicycle</code> or <code>Motorcycle</code> as options for the <code>TravelMode</code>. <note> <code>Bicycle</code> and <code>Motorcycle</code> are only valid when using Grab as a data provider, and only within Southeast Asia. <code>Truck</code> is not available for Grab. For more details on the using Grab for routing, including areas of coverage, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a> in the Amazon Location Service Developer Guide. </note> The <code>TravelMode</code> you specify also determines how you specify route preferences: <ul> <li> If traveling by <code>Car</code> use the <code>CarModeOptions</code> parameter. </li> <li> If traveling by <code>Truck</code> use the <code>TruckModeOptions</code> parameter. </li> </ul> Default Value: <code>Car</code>

DistanceUnitstring

Set the unit system to specify the distance. Default Value: <code>Kilometers</code>

DepartureTimestring

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. <note> Setting a departure time in the past returns a <code>400 ValidationException</code> error. </note> <ul> <li> In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example, <code>2020–07-2T12:15:20.000Z+01:00</code> </li> </ul>

CarModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Car</code>.

TruckModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Truck</code>.

DeparturePositionarrayrequired

The start position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic System (WGS 84)</a> format: <code>[longitude, latitude]</code>. <ul> <li> For example, <code>[-123.115, 49.285]</code> </li> </ul> <note> If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

WaypointPositionsarray

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. <ul> <li> For example, from the <code>DeparturePosition</code> <code>[-123.115, 49.285]</code>, the route follows the order that the waypoint positions are given <code>[[-122.757, 49.0021],[-122.349, 47.620]]</code> </li> </ul> <note> If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. Specifying more than 23 waypoints returns a <code>400 ValidationException</code> error. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

IncludeLegGeometryboolean

Set to include the geometry details in the result for each path between a pair of positions. Default Value: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

DestinationPositionarrayrequired

The finish position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic System (WGS 84)</a> format: <code>[longitude, latitude]</code>. <ul> <li> For example, <code>[-122.339, 47.615]</code> </li> </ul> <note> If you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/routes/v0/calculators/{CalculatorName}/calculate/route

http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route

<a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters: <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a route calculator resource</a>. By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route. Additional options include: <ul> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code> or <code>DepartNow</code>. This calculates a route based on predictive traffic data at the given time. <note> You can't specify both <code>DepartureTime</code> and <code>DepartNow</code> in a single request. Specifying both parameters returns a validation error. </note> </li> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or <code>TruckModeOptions</code> if traveling by <code>Truck</code>. <note> If you specify <code>walking</code> for the travel mode and your data provider is Esri, the start and destination must be within 40km. </note> </li> </ul>

Access Token Required: API Key

Path Parameters

CalculatorNamestringrequired

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

Body Params

DepartNowboolean

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: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

TravelModestring

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose <code>Car</code>, <code>Truck</code>, <code>Walking</code>, <code>Bicycle</code> or <code>Motorcycle</code> as options for the <code>TravelMode</code>. <note> <code>Bicycle</code> and <code>Motorcycle</code> are only valid when using Grab as a data provider, and only within Southeast Asia. <code>Truck</code> is not available for Grab. For more details on the using Grab for routing, including areas of coverage, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a> in the Amazon Location Service Developer Guide. </note> The <code>TravelMode</code> you specify also determines how you specify route preferences: <ul> <li> If traveling by <code>Car</code> use the <code>CarModeOptions</code> parameter. </li> <li> If traveling by <code>Truck</code> use the <code>TruckModeOptions</code> parameter. </li> </ul> Default Value: <code>Car</code>

DistanceUnitstring

Set the unit system to specify the distance. Default Value: <code>Kilometers</code>

DepartureTimestring

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. <note> Setting a departure time in the past returns a <code>400 ValidationException</code> error. </note> <ul> <li> In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example, <code>2020–07-2T12:15:20.000Z+01:00</code> </li> </ul>

CarModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Car</code>.

TruckModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Truck</code>.

DeparturePositionarrayrequired

The start position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic System (WGS 84)</a> format: <code>[longitude, latitude]</code>. <ul> <li> For example, <code>[-123.115, 49.285]</code> </li> </ul> <note> If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

WaypointPositionsarray

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. <ul> <li> For example, from the <code>DeparturePosition</code> <code>[-123.115, 49.285]</code>, the route follows the order that the waypoint positions are given <code>[[-122.757, 49.0021],[-122.349, 47.620]]</code> </li> </ul> <note> If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. Specifying more than 23 waypoints returns a <code>400 ValidationException</code> error. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

IncludeLegGeometryboolean

Set to include the geometry details in the result for each path between a pair of positions. Default Value: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

DestinationPositionarrayrequired

The finish position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic System (WGS 84)</a> format: <code>[longitude, latitude]</code>. <ul> <li> For example, <code>[-122.339, 47.615]</code> </li> </ul> <note> If you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/routes/v0/calculators/{CalculatorName}/calculate/route

http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route

<a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters: <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a route calculator resource</a>. By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route. Additional options include: <ul> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code> or <code>DepartNow</code>. This calculates a route based on predictive traffic data at the given time. <note> You can't specify both <code>DepartureTime</code> and <code>DepartNow</code> in a single request. Specifying both parameters returns a validation error. </note> </li> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or <code>TruckModeOptions</code> if traveling by <code>Truck</code>. <note> If you specify <code>walking</code> for the travel mode and your data provider is Esri, the start and destination must be within 40km. </note> </li> </ul>

Access Token Required: API Key

Path Parameters

CalculatorNamestringrequired

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

Body Params

DepartNowboolean

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: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

TravelModestring

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose <code>Car</code>, <code>Truck</code>, <code>Walking</code>, <code>Bicycle</code> or <code>Motorcycle</code> as options for the <code>TravelMode</code>. <note> <code>Bicycle</code> and <code>Motorcycle</code> are only valid when using Grab as a data provider, and only within Southeast Asia. <code>Truck</code> is not available for Grab. For more details on the using Grab for routing, including areas of coverage, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a> in the Amazon Location Service Developer Guide. </note> The <code>TravelMode</code> you specify also determines how you specify route preferences: <ul> <li> If traveling by <code>Car</code> use the <code>CarModeOptions</code> parameter. </li> <li> If traveling by <code>Truck</code> use the <code>TruckModeOptions</code> parameter. </li> </ul> Default Value: <code>Car</code>

DistanceUnitstring

Set the unit system to specify the distance. Default Value: <code>Kilometers</code>

DepartureTimestring

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. <note> Setting a departure time in the past returns a <code>400 ValidationException</code> error. </note> <ul> <li> In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example, <code>2020–07-2T12:15:20.000Z+01:00</code> </li> </ul>

CarModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Car</code>.

TruckModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Truck</code>.

DeparturePositionarrayrequired

The start position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic System (WGS 84)</a> format: <code>[longitude, latitude]</code>. <ul> <li> For example, <code>[-123.115, 49.285]</code> </li> </ul> <note> If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

WaypointPositionsarray

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. <ul> <li> For example, from the <code>DeparturePosition</code> <code>[-123.115, 49.285]</code>, the route follows the order that the waypoint positions are given <code>[[-122.757, 49.0021],[-122.349, 47.620]]</code> </li> </ul> <note> If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. Specifying more than 23 waypoints returns a <code>400 ValidationException</code> error. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

IncludeLegGeometryboolean

Set to include the geometry details in the result for each path between a pair of positions. Default Value: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

DestinationPositionarrayrequired

The finish position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic System (WGS 84)</a> format: <code>[longitude, latitude]</code>. <ul> <li> For example, <code>[-122.339, 47.615]</code> </li> </ul> <note> If you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/routes/v0/calculators/{CalculatorName}/calculate/route

http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route

<a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters: <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a route calculator resource</a>. By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route. Additional options include: <ul> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code> or <code>DepartNow</code>. This calculates a route based on predictive traffic data at the given time. <note> You can't specify both <code>DepartureTime</code> and <code>DepartNow</code> in a single request. Specifying both parameters returns a validation error. </note> </li> <li> <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or <code>TruckModeOptions</code> if traveling by <code>Truck</code>. <note> If you specify <code>walking</code> for the travel mode and your data provider is Esri, the start and destination must be within 40km. </note> </li> </ul>

Access Token Required: API Key

Path Parameters

CalculatorNamestringrequired

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

Body Params

DepartNowboolean

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: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

TravelModestring

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose <code>Car</code>, <code>Truck</code>, <code>Walking</code>, <code>Bicycle</code> or <code>Motorcycle</code> as options for the <code>TravelMode</code>. <note> <code>Bicycle</code> and <code>Motorcycle</code> are only valid when using Grab as a data provider, and only within Southeast Asia. <code>Truck</code> is not available for Grab. For more details on the using Grab for routing, including areas of coverage, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a> in the Amazon Location Service Developer Guide. </note> The <code>TravelMode</code> you specify also determines how you specify route preferences: <ul> <li> If traveling by <code>Car</code> use the <code>CarModeOptions</code> parameter. </li> <li> If traveling by <code>Truck</code> use the <code>TruckModeOptions</code> parameter. </li> </ul> Default Value: <code>Car</code>

DistanceUnitstring

Set the unit system to specify the distance. Default Value: <code>Kilometers</code>

DepartureTimestring

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. <note> Setting a departure time in the past returns a <code>400 ValidationException</code> error. </note> <ul> <li> In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example, <code>2020–07-2T12:15:20.000Z+01:00</code> </li> </ul>

CarModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Car</code>.

TruckModeOptionsobject

Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Truck</code>.

DeparturePositionarrayrequired

The start position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic System (WGS 84)</a> format: <code>[longitude, latitude]</code>. <ul> <li> For example, <code>[-123.115, 49.285]</code> </li> </ul> <note> If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

WaypointPositionsarray

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. <ul> <li> For example, from the <code>DeparturePosition</code> <code>[-123.115, 49.285]</code>, the route follows the order that the waypoint positions are given <code>[[-122.757, 49.0021],[-122.349, 47.620]]</code> </li> </ul> <note> If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. Specifying more than 23 waypoints returns a <code>400 ValidationException</code> error. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

IncludeLegGeometryboolean

Set to include the geometry details in the result for each path between a pair of positions. Default Value: <code>false</code> Valid Values: <code>false</code> | <code>true</code>

DestinationPositionarrayrequired

The finish position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic System (WGS 84)</a> format: <code>[longitude, latitude]</code>. <ul> <li> For example, <code>[-122.339, 47.615]</code> </li> </ul> <note> If you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position to the nearest road</a>. </note> Valid Values: <code>[-180 to 180,-90 to 90]</code>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://geo.{region}.amazonaws.com/routes/v0/calculators/{CalculatorName}/calculate/route' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}