[ aws . geo-routes ]

calculate-isolines

Description

Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time.

Isolines (also known as isochrones for time-based calculations) are useful for various applications including:

• Service area visualization - Show customers the area you can serve within promised delivery times
• Site selection - Analyze potential business locations based on population within travel distance
• Site selection - Determine areas that can be reached within specified response times

Note

Route preferences such as avoiding toll roads or ferries are treated as preferences rather than absolute restrictions. If a viable route cannot be calculated while honoring all preferences, some may be ignored.

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

See also: AWS API Documentation

Synopsis

  calculate-isolines
[--allow <value>]
[--arrival-time <value>]
[--avoid <value>]
[--depart-now | --no-depart-now]
[--departure-time <value>]
[--destination <value>]
[--destination-options <value>]
[--isoline-geometry-format <value>]
[--isoline-granularity <value>]
[--key <value>]
[--optimize-isoline-for <value>]
[--optimize-routing-for <value>]
[--origin <value>]
[--origin-options <value>]
--thresholds <value>
[--traffic <value>]
[--travel-mode <value>]
[--travel-mode-options <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--allow (structure)

Enables special road types or features that should be considered for routing even if they might be restricted by default for the selected travel mode. These include high-occupancy vehicle and toll lanes.

Hot -> (boolean)

When true, allows the use of HOT (high-occupancy toll) lanes, which may affect travel times and reachable areas.

Default value: false

Hov -> (boolean)

When true, allows the use of HOV (high-occupancy vehicle) lanes, which may affect travel times and reachable areas.

Default value: false

Shorthand Syntax:

Hot=boolean,Hov=boolean

JSON Syntax:

{
  "Hot": true|false,
  "Hov": true|false
}

--arrival-time (string)

Determine areas from which Destination can be reached by this time, taking into account predicted traffic conditions and working backward to account for congestion patterns. This attribute cannot be used together with DepartureTime or DepartNow . Specified as an ISO-8601 timestamp with timezone offset.

Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Constraints:

• pattern: ([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])

--avoid (structure)

Specifies road types, features, or areas to avoid (if possible) when calculating reachable areas. These are treated as preferences rather than strict constraints—if a route cannot be calculated without using an avoided feature, that avoidance preference may be ignored.

Areas -> (list)

Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists.

(structure)

Defines an area to avoid when calculating routes. Consists of a primary geometry to avoid, with the ability to specify exception areas within that geometry where travel is permitted.

Except -> (list)

Areas within the primary avoidance geometry where travel is allowed. For example, you might want to avoid a neighborhood but allow travel on a major road that passes through it.

(structure)

Defines an area to avoid during calculations using one of several supported geometry types. The service will prefer routes that avoid these areas when possible.

BoundingBox -> (list)

A rectangular area defined by its southwest and northeast corners: [min longitude, min latitude, max longitude, max latitude] .

Constraints:

• min: 4
• max: 4

(double)

Corridor -> (structure)

A buffer zone around a line, defined by a series of coordinates and a radius in meters.

LineString -> (list) [required]

An ordered list of positions used to plot a route on a map.

Note

LineString and Polyline are mutually exclusive properties.

Constraints:

• min: 2

(list)

Constraints:

• min: 2
• max: 2

(double)

Radius -> (integer) [required]

Radius that defines the width of the corridor.

Polygon -> (list)

A polygon defined by a list of coordinate rings. The first ring defines the outer boundary; subsequent rings will be ignored.

Constraints:

• min: 1
• max: 1

(list)

Constraints:

• min: 4

(list)

Constraints:

• min: 2
• max: 2

(double)

PolylineCorridor -> (structure)

A buffer zone around a compressed polyline, defined by an encoded polyline string and a radius in meters. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline .

Polyline -> (string) [required]

An ordered list of positions used to plot a route on a map in a lossy compression format.

Note

LineString and Polyline are mutually exclusive properties.

Constraints:

• min: 1

Radius -> (integer) [required]

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit : meters

PolylinePolygon -> (list)

A polygon defined by encoded polyline strings. The first string defines the outer boundary; subsequent strings will be ignored. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline .

Constraints:

• min: 1
• max: 1

(string)

Constraints:

• min: 1

Geometry -> (structure) [required]

The primary area to avoid, specified using a bounding box, corridor, polygon, or polyline corridor.

BoundingBox -> (list)

A rectangular area defined by its southwest and northeast corners: [min longitude, min latitude, max longitude, max latitude] .

Constraints:

• min: 4
• max: 4

(double)

Corridor -> (structure)

A buffer zone around a line, defined by a series of coordinates and a radius in meters.

LineString -> (list) [required]

An ordered list of positions used to plot a route on a map.

Note

LineString and Polyline are mutually exclusive properties.

Constraints:

• min: 2

(list)

Constraints:

• min: 2
• max: 2

(double)

Radius -> (integer) [required]

Radius that defines the width of the corridor.

Polygon -> (list)

A polygon defined by a list of coordinate rings. The first ring defines the outer boundary; subsequent rings will be ignored.

Constraints:

• min: 1
• max: 1

(list)

Constraints:

• min: 4

(list)

Constraints:

• min: 2
• max: 2

(double)

PolylineCorridor -> (structure)

A buffer zone around a compressed polyline, defined by an encoded polyline string and a radius in meters. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline .

Polyline -> (string) [required]

An ordered list of positions used to plot a route on a map in a lossy compression format.

Note

LineString and Polyline are mutually exclusive properties.

Constraints:

• min: 1

Radius -> (integer) [required]

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit : meters

PolylinePolygon -> (list)

A polygon defined by encoded polyline strings. The first string defines the outer boundary; subsequent strings will be ignored. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline .

Constraints:

• min: 1
• max: 1

(string)

Constraints:

• min: 1

CarShuttleTrains -> (boolean)

Indicates a preference to avoid car shuttle trains (auto trains) where possible. These may still be included if no reasonable alternative route exists.

ControlledAccessHighways -> (boolean)

Indicates a preference to avoid controlled-access highways (such as interstate highways or motorways) where possible. If a viable route cannot be calculated using only local roads, controlled-access highways may still be included.

DirtRoads -> (boolean)

Indicates a preference to avoid unpaved or dirt roads where possible. Routes may still include dirt roads if no reasonable paved alternative exists.

Ferries -> (boolean)

Indicates a preference to avoid ferries where possible. If a viable route cannot be calculated without using ferries, they may still be included.

SeasonalClosure -> (boolean)

Indicates a preference to avoid roads that may be subject to seasonal closures where possible. These roads may still be included if no reasonable year-round alternative exists.

TollRoads -> (boolean)

Indicates a preference to avoid toll roads where possible. If a viable route cannot be calculated without using toll roads, they may still be included.

TollTransponders -> (boolean)

Indicates a preference to avoid roads that require electronic toll collection transponders where possible. These roads may still be included if no viable alternative route exists.

TruckRoadTypes -> (list)

For truck travel modes, indicates specific road classification types in Sweden (BK1 through BK4 ) and Mexico (A2, A4, B2, B4, C, D, ET2, ET4 ) to avoid where possible. These road types may still be used if no reasonable alternative exists.

Note

There are currently no other supported values as of 26th April 2024.

Constraints:

• min: 1
• max: 12

(string)

Constraints:

• min: 1
• max: 3

Tunnels -> (boolean)

Indicates a preference to avoid tunnels where possible. If a viable route cannot be calculated without using tunnels, they may still be included.

UTurns -> (boolean)

Indicates a preference to avoid U-turns where possible. U-turns may still be included if necessary to reach certain areas or when no reasonable alternative exists.

ZoneCategories -> (list)

Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists.

Constraints:

• min: 0
• max: 3

(structure)

Types of regulated zones that may affect routing.

Category -> (string)

The type of regulated zone: CongestionPricing for toll zones based on traffic levels, Environmental for low-emission zones, or Vignette for areas requiring special permits or stickers.

Possible values:

• CongestionPricing
• Environmental
• Vignette

JSON Syntax:

{
  "Areas": [
    {
      "Except": [
        {
          "BoundingBox": [double, ...],
          "Corridor": {
            "LineString": [
              [double, ...]
              ...
            ],
            "Radius": integer
          },
          "Polygon": [
            [
              [double, ...]
              ...
            ]
            ...
          ],
          "PolylineCorridor": {
            "Polyline": "string",
            "Radius": integer
          },
          "PolylinePolygon": ["string", ...]
        }
        ...
      ],
      "Geometry": {
        "BoundingBox": [double, ...],
        "Corridor": {
          "LineString": [
            [double, ...]
            ...
          ],
          "Radius": integer
        },
        "Polygon": [
          [
            [double, ...]
            ...
          ]
          ...
        ],
        "PolylineCorridor": {
          "Polyline": "string",
          "Radius": integer
        },
        "PolylinePolygon": ["string", ...]
      }
    }
    ...
  ],
  "CarShuttleTrains": true|false,
  "ControlledAccessHighways": true|false,
  "DirtRoads": true|false,
  "Ferries": true|false,
  "SeasonalClosure": true|false,
  "TollRoads": true|false,
  "TollTransponders": true|false,
  "TruckRoadTypes": ["string", ...],
  "Tunnels": true|false,
  "UTurns": true|false,
  "ZoneCategories": [
    {
      "Category": "CongestionPricing"|"Environmental"|"Vignette"
    }
    ...
  ]
}

--depart-now | --no-depart-now (boolean)

When true, uses the current time as the departure time and takes current traffic conditions into account. This attribute cannot be used together with DepartureTime or ArrivalTime .

--departure-time (string)

Determine areas that can be reached when departing at this time, taking into account predicted traffic conditions. This attribute cannot be used together with ArrivalTime or DepartNow . Specified as an ISO-8601 timestamp with timezone offset.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Constraints:

• pattern: ([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])

--destination (list)

An optional destination point, specified as [longitude, latitude] coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either Origin or Destination must be provided.

Constraints:

• min: 2
• max: 2

(double)

Syntax:

double double ...

--destination-options (structure)

Options that control how the destination point is matched to the road network and how routes can approach it. These options help improve travel time accuracy by accounting for real-world access to the destination.

AvoidActionsForDistance -> (long)

The distance in meters from the destination point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the endpoint.

Constraints:

• min: 0
• max: 4294967295

Heading -> (double)

The initial direction of travel in degrees (0-360, where 0 is north). This can affect which road segments are considered accessible from the starting point.

Constraints:

• min: 0.0
• max: 360.0

Matching -> (structure)

Controls how the destination point is matched to the road network, including search radius and name-based matching preferences.

NameHint -> (string)

The expected street name near the point. Helps disambiguate matching when multiple roads are within range.

OnRoadThreshold -> (long)

The maximum distance in meters that a point can be from a road while still being considered “on” that road. Points further than this distance require explicit matching.

Unit : meters

Constraints:

• min: 0
• max: 4294967295

Radius -> (long)

The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified Strategy

Unit : meters

Constraints:

• min: 0
• max: 4294967295

Strategy -> (string)

Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.

Possible values:

• MatchAny
• MatchMostSignificantRoad

SideOfStreet -> (structure)

Specifies which side of the street should be considered accessible, which is important when building entrances or parking access points are only reachable from one side of the road.

Position -> (list) [required]

The [longitude, latitude] coordinates of the point that should be matched to a specific side of the street.

Constraints:

• min: 2
• max: 2

(double)

UseWith -> (string)

Controls whether side-of-street matching is applied to any street (AnyStreet ) or only to divided roads (DividedStreetOnly ). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don’t account for necessary U-turns or detours to reach the correct side.

Default value: DividedStreetOnly

Possible values:

• AnyStreet
• DividedStreetOnly

Shorthand Syntax:

AvoidActionsForDistance=long,Heading=double,Matching={NameHint=string,OnRoadThreshold=long,Radius=long,Strategy=string},SideOfStreet={Position=[double,double],UseWith=string}

JSON Syntax:

{
  "AvoidActionsForDistance": long,
  "Heading": double,
  "Matching": {
    "NameHint": "string",
    "OnRoadThreshold": long,
    "Radius": long,
    "Strategy": "MatchAny"|"MatchMostSignificantRoad"
  },
  "SideOfStreet": {
    "Position": [double, ...],
    "UseWith": "AnyStreet"|"DividedStreetOnly"
  }
}

--isoline-geometry-format (string)

The format of the returned IsolineGeometry.

Default value:FlexiblePolyline

Possible values:

• FlexiblePolyline
• Simple

--isoline-granularity (structure)

Controls the detail level of the generated isolines. Higher granularity produces smoother shapes but requires more processing time and results in larger responses.

MaxPoints -> (integer)

The maximum number of points used to define each isoline. Higher values create smoother, more detailed shapes.

Constraints:

• min: 31

MaxResolution -> (long)

The maximum distance in meters between points along the isoline. Smaller values create more detailed shapes.

Unit : meters

Constraints:

• min: 0
• max: 4294967295

Shorthand Syntax:

MaxPoints=integer,MaxResolution=long

JSON Syntax:

{
  "MaxPoints": integer,
  "MaxResolution": long
}

--key (string)

An Amazon Location Service API Key with access to this action. If omitted, the request must be signed using Signature Version 4.

Constraints:

• min: 0
• max: 1000

--optimize-isoline-for (string)

Controls the trade-off between calculation speed and isoline precision. Choose FastCalculation for quicker results with less detail, AccurateCalculation for more precise results, or BalancedCalculation for a middle ground.

Default value: BalancedCalculation

Possible values:

• AccurateCalculation
• BalancedCalculation
• FastCalculation

--optimize-routing-for (string)

Determines whether routes prioritize shortest travel time (FastestRoute ) or shortest physical distance (ShortestRoute ) when calculating reachable areas.

Default value: FastestRoute

Possible values:

• FastestRoute
• ShortestRoute

--origin (list)

The starting point for isoline calculations, specified as [longitude, latitude] coordinates. For example, this could be a store location, service center, or any point from which you want to calculate reachable areas. Either Origin or Destination must be provided.

Constraints:

• min: 2
• max: 2

(double)

Syntax:

double double ...

--origin-options (structure)

Options that control how the origin point is matched to the road network and how routes can depart from it. These options help improve travel time accuracy by accounting for real-world access from the origin.

AvoidActionsForDistance -> (long)

The distance in meters from the origin point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the starting point.

Constraints:

• min: 0
• max: 4294967295

Heading -> (double)

Initial direction of travel in degrees (0-360, where 0 is north). This affects which road segments are considered accessible from the starting point and is particularly useful when the origin is on a divided road or at a complex intersection.

Constraints:

• min: 0.0
• max: 360.0

Matching -> (structure)

Controls how the origin point is matched to the road network, including search radius and matching strategy.

NameHint -> (string)

The expected street name near the point. Helps disambiguate matching when multiple roads are within range.

OnRoadThreshold -> (long)

The maximum distance in meters that a point can be from a road while still being considered “on” that road. Points further than this distance require explicit matching.

Unit : meters

Constraints:

• min: 0
• max: 4294967295

Radius -> (long)

The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified Strategy

Unit : meters

Constraints:

• min: 0
• max: 4294967295

Strategy -> (string)

Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.

Possible values:

• MatchAny
• MatchMostSignificantRoad

SideOfStreet -> (structure)

Controls which side of the street is considered accessible from the origin point, particularly important for divided roads where building entrances or parking access may only be available from one direction.

Position -> (list) [required]

The [longitude, latitude] coordinates of the point that should be matched to a specific side of the street.

Constraints:

• min: 2
• max: 2

(double)

UseWith -> (string)

Controls whether side-of-street matching is applied to any street (AnyStreet ) or only to divided roads (DividedStreetOnly ). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don’t account for necessary U-turns or detours to reach the correct side.

Default value: DividedStreetOnly

Possible values:

• AnyStreet
• DividedStreetOnly

Shorthand Syntax:

AvoidActionsForDistance=long,Heading=double,Matching={NameHint=string,OnRoadThreshold=long,Radius=long,Strategy=string},SideOfStreet={Position=[double,double],UseWith=string}

JSON Syntax:

{
  "AvoidActionsForDistance": long,
  "Heading": double,
  "Matching": {
    "NameHint": "string",
    "OnRoadThreshold": long,
    "Radius": long,
    "Strategy": "MatchAny"|"MatchMostSignificantRoad"
  },
  "SideOfStreet": {
    "Position": [double, ...],
    "UseWith": "AnyStreet"|"DividedStreetOnly"
  }
}

--thresholds (structure) [required]

The distance or time thresholds used to determine reachable areas. You can specify up to five thresholds (which all must be the same type) to calculate multiple isolines in a single request. For example, to determine the areas that are reachable within 10 and 20 minutes of the origin, specify time thresholds of 600 and 1200 seconds.

You incur a calculation charge for each threshold. Using a large number of thresholds in a request can lead to unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide .

Distance -> (list)

List of travel distances in meters. For example, [1000, 2000, 5000] would calculate areas reachable within 1, 2, and 5 kilometers.

Constraints:

• min: 1
• max: 5

(long)

Constraints:

• min: 0
• max: 300000

Time -> (list)

List of travel times in seconds. For example, [300, 600, 900] would calculate areas reachable within 5, 10, and 15 minutes.

Constraints:

• min: 1
• max: 5

(long)

Constraints:

• min: 0
• max: 10800

Shorthand Syntax:

Distance=long,long,Time=long,long

JSON Syntax:

{
  "Distance": [long, ...],
  "Time": [long, ...]
}

--traffic (structure)

Configures how real-time and historical traffic data affects isoline calculations. Traffic patterns can significantly impact reachable areas, especially during peak hours.

FlowEventThresholdOverride -> (long)

The duration in seconds that real-time congestion data is considered valid before reverting to historical traffic patterns. This helps balance between using current conditions and more predictable historical data when calculating travel times.

Unit : seconds

Constraints:

• min: 0
• max: 4294967295

Usage -> (string)

Controls whether traffic data is used in calculations. UseTrafficData considers both real-time congestion and historical patterns, while IgnoreTrafficData calculates routes based solely on road types and speed limits. Using traffic data provides more accurate real-world estimates but may produce different results at different times of day.

Default value: UseTrafficData

Possible values:

• IgnoreTrafficData
• UseTrafficData

Shorthand Syntax:

FlowEventThresholdOverride=long,Usage=string

JSON Syntax:

{
  "FlowEventThresholdOverride": long,
  "Usage": "IgnoreTrafficData"|"UseTrafficData"
}

--travel-mode (string)

The mode of transportation to use for calculations. This affects which road types or features can be used, estimated speed, and the traffic levels that are applied.

• Car —Standard passenger vehicle routing using roads accessible to cars
• Pedestrian —Walking routes using pedestrian paths, sidewalks, and crossings
• Scooter —Light two-wheeled vehicle routing using roads and paths accessible to scooters
• Truck —Commercial truck routing considering vehicle dimensions, weight restrictions, and hazardous material regulations

Note

The mode Scooter also applies to motorcycles; set this to Scooter when calculating isolines for motorcycles.

Default value: Car

Possible values:

• Car
• Pedestrian
• Scooter
• Truck

--travel-mode-options (structure)

Additional attributes that refine how reachable areas are calculated based on specific vehicle characteristics. These options help produce more accurate results by accounting for real-world constraints and capabilities.

For example:

• For trucks (Truck ), specify dimensions, weight limits, and hazardous cargo restrictions to ensure isolines only include roads that can physically and legally accommodate the vehicle
• For cars (Car ), set maximum speed capabilities or indicate high-occupancy vehicle eligibility to better estimate reachable areas
• For scooters (Scooter ), specify engine type and speed limitations to more accurately model their travel capabilities

Without these options, calculations use default assumptions that may not match your specific use case.

Car -> (structure)

Options specific to passenger vehicle routing (Car , such as vehicle characteristics and license plate restrictions.

EngineType -> (string)

The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

• INTERNAL_COMBUSTION —Standard gasoline or diesel engine.
• ELECTRIC —Battery electric vehicle.
• PLUGIN_HYBRID —Combination of electric and internal combustion engines with plug-in charging capability.

Possible values:

• Electric
• InternalCombustion
• PluginHybrid

LicensePlate -> (structure)

License plate information used in regions where road access or routing restrictions are based on license plate numbers.

LastCharacter -> (string)

The last character of the vehicle’s license plate. Used to determine road access restrictions in regions with license plate-based traffic management systems.

Constraints:

• min: 1
• max: 1

MaxSpeed -> (double)

The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).

Unit : kilometers per hour

Constraints:

• min: 3.6
• max: 252.0

Occupancy -> (integer)

The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

Default value: 1

Constraints:

• min: 1

Scooter -> (structure)

Options specific to scooter routing (Scooter , such as vehicle characteristics and license plate restrictions.

Note

When using the Scooter travel mode, controlled-access highways are automatically avoided unless explicitly allowed.

EngineType -> (string)

The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

• INTERNAL_COMBUSTION —Standard gasoline or diesel engine.
• ELECTRIC —Battery electric vehicle.
• PLUGIN_HYBRID —Combination of electric and internal combustion engines with plug-in charging capability.

Possible values:

• Electric
• InternalCombustion
• PluginHybrid

LicensePlate -> (structure)

License plate information used in regions where road access or routing restrictions are based on license plate numbers.

LastCharacter -> (string)

The last character of the vehicle’s license plate. Used to determine road access restrictions in regions with license plate-based traffic management systems.

Constraints:

• min: 1
• max: 1

MaxSpeed -> (double)

The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).

Unit : kilometers per hour

Constraints:

• min: 3.6
• max: 252.0

Occupancy -> (integer)

The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

Default value: 1

Constraints:

• min: 1

Truck -> (structure)

Options specific to commercial truck routing (Truck , including vehicle dimensions, weight limits, and hazardous cargo specifications.

AxleCount -> (integer)

The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.

Constraints:

• min: 2
• max: 255

EngineType -> (string)

The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

• INTERNAL_COMBUSTION —Standard gasoline or diesel engine.
• ELECTRIC —Battery electric vehicle.
• PLUGIN_HYBRID —Combination of electric and internal combustion engines with plug-in charging capability.

Possible values:

• Electric
• InternalCombustion
• PluginHybrid

GrossWeight -> (long)

The gross vehicle weight (the maximum weight a vehicle can safely operate at, as specified by the manufacturer) in kilograms. Used to avoid roads with weight restrictions and ensure compliance with maximum allowed vehicle weight regulations.

Unit : kilograms

Constraints:

• min: 0
• max: 4294967295

HazardousCargos -> (list)

Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.

• Combustible —Materials that can burn readily
• Corrosive —Materials that can destroy or irreversibly damage other substances
• Explosive —Materials that can produce an explosion by chemical reaction
• Flammable —Materials that can easily ignite
• Gas —Hazardous materials in gaseous form
• HarmfulToWater —Materials that pose a risk to water sources if released
• Organic —Hazardous organic compounds
• Other —Hazardous materials not covered by other categories
• Poison —Toxic materials
• PoisonousInhalation —Materials that are toxic when inhaled
• Radioactive —Materials that emit ionizing radiation

Constraints:

• min: 0
• max: 11

(string)

Possible values:

• Combustible
• Corrosive
• Explosive
• Flammable
• Gas
• HarmfulToWater
• Organic
• Other
• Poison
• PoisonousInhalation
• Radioactive

Height -> (long)

The vehicle height in centimeters. Used to avoid routes with low bridges or other height restrictions.

Unit : centimeters

Constraints:

• min: 0
• max: 5000

HeightAboveFirstAxle -> (long)

The height in centimeters measured from the ground to the highest point above the first axle. Used for specific bridge and tunnel clearance restrictions.

Unit : centimeters

Constraints:

• min: 0
• max: 5000

KpraLength -> (long)

The kingpin to rear axle (KPRA) length in centimeters. Used to determine if the vehicle can safely navigate turns and intersections.

Unit : centimeters

Constraints:

• min: 0
• max: 4294967295

Length -> (long)

The total vehicle length in centimeters. Used to avoid roads with length restrictions and determine if the vehicle can safely navigate turns.

Unit : centimeters

Constraints:

• min: 0
• max: 30000

LicensePlate -> (structure)

License plate information used in regions where road access or routing restrictions are based on license plate numbers.

LastCharacter -> (string)

The last character of the vehicle’s license plate. Used to determine road access restrictions in regions with license plate-based traffic management systems.

Constraints:

• min: 1
• max: 1

MaxSpeed -> (double)

The maximum speed in kilometers per hour at which the vehicle can or is permitted to travel. This affects travel time calculations and may result in different reachable areas compared to using default speed limits. Value must be between 3.6 and 252 kilometers per hour.

Unit : kilometers per hour

Constraints:

• min: 3.6
• max: 252.0

Occupancy -> (integer)

The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

Default value: 1

Constraints:

• min: 1

PayloadCapacity -> (long)

The maximum cargo weight in kilograms that the vehicle (including attached trailers) is rated to carry.

Unit : kilograms

Constraints:

• min: 0
• max: 4294967295

TireCount -> (integer)

The total number of tires on the vehicle.

Constraints:

• min: 1
• max: 255

Trailer -> (structure)

Optional specifications for attached trailers. When provided, trailer characteristics affect route calculations to ensure compliance with trailer-specific restrictions such as length limits, weight distribution requirements, and access restrictions for multi-trailer configurations.

AxleCount -> (integer)

The total number of axles across all trailers. Used for weight distribution calculations and road restrictions.

Constraints:

• min: 1

TrailerCount -> (integer)

The number of trailers being pulled. Affects which roads can be used based on local regulations.

Default value: 0

Constraints:

• min: 1
• max: 255

TruckType -> (string)

The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.

Possible values:

• LightTruck
• StraightTruck
• Tractor

TunnelRestrictionCode -> (string)

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

• Tunnel Category B
  • Risk Level : Limited risk
  • Restrictions : Few restrictions
• Tunnel Category C
  • Risk Level : Medium risk
  • Restrictions : Some restrictions
• Tunnel Category D
  • Risk Level : High risk
  • Restrictions : Many restrictions occur
• Tunnel Category E
  • Risk Level : Very high risk
  • Restrictions : Restricted tunnel

Constraints:

• min: 1
• max: 1

WeightPerAxle -> (long)

The heaviest weight per axle in kilograms, regardless of axle type or grouping. Used for roads with axle-weight restrictions in regions where regulations don’t distinguish between different axle configurations.

Unit : kilograms

Constraints:

• min: 0
• max: 4294967295

WeightPerAxleGroup -> (structure)

Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.

Unit : kilograms

Single -> (long)

Total weight in kilograms for single axle configurations.

Unit : kilograms

Constraints:

• min: 0
• max: 4294967295

Tandem -> (long)

Total weight in kilograms for tandem (two adjacent) axle configurations.

Unit : kilograms

Constraints:

• min: 0
• max: 4294967295

Triple -> (long)

Total weight in kilograms for triple (three adjacent) axle configurations.

Unit : kilograms

Constraints:

• min: 0
• max: 4294967295

Quad -> (long)

Total weight in kilograms for quad (four adjacent) axle configurations.

Unit : kilograms

Constraints:

• min: 0
• max: 4294967295

Quint -> (long)

Total weight in kilograms for quint (five adjacent) axle configurations.

Unit : kilograms

Constraints:

• min: 0
• max: 4294967295

Width -> (long)

The vehicle width in centimeters. Used to avoid routes with width restrictions.

Unit : centimeters

Constraints:

• min: 0
• max: 5000

Shorthand Syntax:

Car={EngineType=string,LicensePlate={LastCharacter=string},MaxSpeed=double,Occupancy=integer},Scooter={EngineType=string,LicensePlate={LastCharacter=string},MaxSpeed=double,Occupancy=integer},Truck={AxleCount=integer,EngineType=string,GrossWeight=long,HazardousCargos=[string,string],Height=long,HeightAboveFirstAxle=long,KpraLength=long,Length=long,LicensePlate={LastCharacter=string},MaxSpeed=double,Occupancy=integer,PayloadCapacity=long,TireCount=integer,Trailer={AxleCount=integer,TrailerCount=integer},TruckType=string,TunnelRestrictionCode=string,WeightPerAxle=long,WeightPerAxleGroup={Single=long,Tandem=long,Triple=long,Quad=long,Quint=long},Width=long}

JSON Syntax:

{
  "Car": {
    "EngineType": "Electric"|"InternalCombustion"|"PluginHybrid",
    "LicensePlate": {
      "LastCharacter": "string"
    },
    "MaxSpeed": double,
    "Occupancy": integer
  },
  "Scooter": {
    "EngineType": "Electric"|"InternalCombustion"|"PluginHybrid",
    "LicensePlate": {
      "LastCharacter": "string"
    },
    "MaxSpeed": double,
    "Occupancy": integer
  },
  "Truck": {
    "AxleCount": integer,
    "EngineType": "Electric"|"InternalCombustion"|"PluginHybrid",
    "GrossWeight": long,
    "HazardousCargos": ["Combustible"|"Corrosive"|"Explosive"|"Flammable"|"Gas"|"HarmfulToWater"|"Organic"|"Other"|"Poison"|"PoisonousInhalation"|"Radioactive", ...],
    "Height": long,
    "HeightAboveFirstAxle": long,
    "KpraLength": long,
    "Length": long,
    "LicensePlate": {
      "LastCharacter": "string"
    },
    "MaxSpeed": double,
    "Occupancy": integer,
    "PayloadCapacity": long,
    "TireCount": integer,
    "Trailer": {
      "AxleCount": integer,
      "TrailerCount": integer
    },
    "TruckType": "LightTruck"|"StraightTruck"|"Tractor",
    "TunnelRestrictionCode": "string",
    "WeightPerAxle": long,
    "WeightPerAxleGroup": {
      "Single": long,
      "Tandem": long,
      "Triple": long,
      "Quad": long,
      "Quint": long
    },
    "Width": long
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

ArrivalTime -> (string)

Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the Destination and ArrivalTime attributes were provided in the request.

Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Constraints:

• pattern: ([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])

DepartureTime -> (string)

Time of departure from the origin, used for traffic calculations. This attribute is returned when Origin was provided in the request and either a specific departure time was requested (DepartureTime ) or DepartNow was set to true.

Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Constraints:

• pattern: ([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])

IsolineGeometryFormat -> (string)

The format of the returned geometries, matching the format specified in the request. Either FlexiblePolyline for compact encoding or Simple for GeoJSON-compatible coordinates.

Default value:FlexiblePolyline

Possible values:

• FlexiblePolyline
• Simple

Isolines -> (list)

Reachable areas, or isolines, for each threshold specified in the request.

Constraints:

• min: 1
• max: 5

(structure)

Represents a single reachable area calculated for a specific threshold.

Connections -> (list) [required]

Lines connecting separate parts of the reachable area that can be reached within the same threshold. These occur when areas are reachable but not contiguous, such as when separated by water or unroutable areas. When present, these lines represent actual transportation network segments (such as ferry routes or bridges) that connect the separated areas.

(structure)

Represents a segment of the transportation network that connects separate parts of a reachable area. These connections show how discontinuous areas are linked, such as by ferry routes or bridges crossing unroutable terrain.

FromPolygonIndex -> (integer) [required]

The index of the starting polygon in the isoline’s Geometries list.

Constraints:

• min: 0

Geometry -> (structure) [required]

The shape of the connection, representing the actual path through the transportation network that links the polygons.

LineString -> (list)

A series of [longitude, latitude] coordinate pairs defining the connection path when Simple geometry format is requested. These coordinates can be directly used as the coordinates array in a GeoJSON LineString without transformation.

Note

LineString and Polyline are mutually exclusive properties.

Constraints:

• min: 2

(list)

Constraints:

• min: 2
• max: 2

(double)

Polyline -> (string)

An encoded representation of the connection path when FlexiblePolyline geometry format is requested. This provides a more compact representation suitable for transmission and storage. To convert to GeoJSON, first decode to obtain coordinate pairs, then use those coordinates as the coordinates array in a GeoJSON LineString.

Note

LineString and Polyline are mutually exclusive properties.

Constraints:

• min: 1

ToPolygonIndex -> (integer) [required]

The index of the ending polygon in the isoline’s Geometries list.

Constraints:

• min: 0

DistanceThreshold -> (long)

The travel distance in meters used to calculate this isoline, if distance-based thresholds were specified in the request.

Constraints:

• min: 0
• max: 4294967295

Geometries -> (list) [required]

The shapes that define the reachable area, provided in the requested geometry format.

(structure)

Represents the shape of a reachable area. The geometry can be provided either as coordinate pairs (Polygon ) or in encoded format (PolylinePolygon ), matching the format specified in the request.

Polygon -> (list)

A series of coordinate rings defining the reachable area when Simple geometry format is requested. Each ring is a list of [longitude, latitude] coordinate pairs. The first ring defines the outer boundary; subsequent rings define holes representing unreachable areas.

Note

Polygon and PolylinePolygon are mutually exclusive properties.

Constraints:

• min: 1

(list)

Constraints:

• min: 4

(list)

Constraints:

• min: 2
• max: 2

(double)

PolylinePolygon -> (list)

An encoded representation of the reachable area when FlexiblePolyline geometry format is requested. Provides a compact representation suitable for transmission and storage. The first string defines the outer boundary; subsequent strings define holes representing unreachable areas. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline .

Note

Polygon and PolylinePolygon are mutually exclusive properties.

Constraints:

• min: 1

(string)

Constraints:

• min: 1

TimeThreshold -> (long)

The travel time in seconds used to calculate this isoline, if time-based thresholds were specified in the request.

Constraints:

• min: 0
• max: 4294967295

PricingBucket -> (string)

The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.

SnappedDestination -> (list)

The actual point on the road network used for calculations, which may differ from the requested destination if Destination was not directly on a road.

Constraints:

• min: 2
• max: 2

(double)

SnappedOrigin -> (list)

The actual point on the road network used for calculations, which may differ from the requested origin if Origin was not directly on a road.

Constraints:

• min: 2
• max: 2

(double)