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

The Amazon Location Service multi-region endpoint

http://geo.{region}.amazonaws.com

POST

Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition. Requires that you first create a route calculator resource

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:

Specifying a departure time using either DepartureTime or DepartureNow. This calculates a route based on predictive traffic data at the given time.
Specifying a travel mode using TravelMode. This lets you specify an additional route preference such as CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480InternalServerException

🟠481ResourceNotFoundException

🟠482AccessDeniedException

🟠483ValidationException

🟠484ThrottlingException

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://geo.{region}.amazonaws.com/routes/v0/calculators//calculate/route' \
--header 'Content-Type: application/json' \
--data-raw '{
    "CarModeOptions": {
        "AvoidFerries": true,
        "AvoidTolls": true
    },
    "DepartNow": true,
    "DeparturePosition": [
        0,
        0
    ],
    "DepartureTime": "2019-08-24T14:15:22.123Z",
    "DestinationPosition": [
        0,
        0
    ],
    "DistanceUnit": "Kilometers",
    "IncludeLegGeometry": true,
    "TravelMode": "Car",
    "TruckModeOptions": {
        "AvoidFerries": true,
        "AvoidTolls": true,
        "Dimensions": {
            "Height": 0,
            "Length": 0,
            "Unit": "Meters",
            "Width": 0
        },
        "Weight": {
            "Total": 0,
            "Unit": "Kilograms"
        }
    },
    "WaypointPositions": [
        [
            0,
            0
        ]
    ]
}'

Response Example

200 - Example 1

{
    "Legs": [],
    "Summary": {
        "DataSource": "string",
        "Distance": 0,
        "DistanceUnit": "Kilometers",
        "DurationSeconds": 0,
        "RouteBBox": []
    }
}

Modified at 2022-09-10 19:59:22

/tracking/v0/trackers/{TrackerName}/positions

/geofencing/v0/collections