[ aws . geo-routes ]
calculate-isolines
Description
Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.
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]
Options
--allow (structure)
Features that are allowed while calculating an isoline.
Hot -> (boolean)
Allow Hot (High Occupancy Toll) lanes while calculating an isoline.
Default value: false
Hov -> (boolean)
Allow Hov (High Occupancy vehicle) lanes while calculating an isoline.
Default value: false
Shorthand Syntax:
Hot=boolean,Hov=boolean
JSON Syntax:
{
"Hot": true|false,
"Hov": true|false
}
--arrival-time (string)
Time of arrival at the destination.
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
--avoid (structure)
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can’t be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.
Areas -> (list)
Areas to be avoided.
(structure)
The area to be avoided.
Except -> (list)
Exceptions to the provided avoidance geometry, to be included while calculating an isoline.
(structure)
The avoidance geometry, to be included while calculating an isoline.
BoundingBox -> (list)
Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
(double)
Corridor -> (structure)
Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
LineString -> (list)
An ordered list of positions used to plot a route on a map.
Note
LineString and Polyline are mutually exclusive properties.(list)
Radius -> (integer)
Polygon -> (list)
A list of Polygon will be excluded for calculating isolines, the list can only contain 1 polygon.
(list)
(list)
PolylineCorridor -> (structure)
Geometry defined as an encoded corridor – a polyline with a radius that defines the width of the corridor. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md .
Polyline -> (string)
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.Radius -> (integer)
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Meters
PolylinePolygon -> (list)
A list of PolylinePolygon’s that are excluded for calculating isolines, the list can only contain 1 polygon. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md .
(string)
Geometry -> (structure)
Geometry of the area to be avoided.
BoundingBox -> (list)
Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
(double)
Corridor -> (structure)
Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
LineString -> (list)
An ordered list of positions used to plot a route on a map.
Note
LineString and Polyline are mutually exclusive properties.(list)
Radius -> (integer)
Polygon -> (list)
A list of Polygon will be excluded for calculating isolines, the list can only contain 1 polygon.
(list)
(list)
PolylineCorridor -> (structure)
Geometry defined as an encoded corridor – a polyline with a radius that defines the width of the corridor. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md .
Polyline -> (string)
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.Radius -> (integer)
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Meters
PolylinePolygon -> (list)
A list of PolylinePolygon’s that are excluded for calculating isolines, the list can only contain 1 polygon. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md .
(string)
CarShuttleTrains -> (boolean)
ControlledAccessHighways -> (boolean)
DirtRoads -> (boolean)
Ferries -> (boolean)
SeasonalClosure -> (boolean)
TollRoads -> (boolean)
TollTransponders -> (boolean)
TruckRoadTypes -> (list)
Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
Note
There are currently no other supported values as of 26th April 2024.(string)
Tunnels -> (boolean)
UTurns -> (boolean)
ZoneCategories -> (list)
Zone categories to be avoided.
(structure)
Zone category to be avoided.
Category -> (string)
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)
--departure-time (string)
Time of departure from thr origin.
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
--destination (list)
The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude] .
(double)
Syntax:
double double ...
--destination-options (structure)
Destination related options.
AvoidActionsForDistance -> (long)
Heading -> (double)
Matching -> (structure)
Options to configure matching the provided position to the road network.
NameHint -> (string)
OnRoadThreshold -> (long)
If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
meters
Radius -> (long)
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Meters
Strategy -> (string)
SideOfStreet -> (structure)
Options to configure matching the provided position to a side of the street.
Position -> (list)
Position defined as [longitude, latitude] .
(double)
UseWith -> (string)
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
Default Value: 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:
FlexiblePolylineSimple
--isoline-granularity (structure)
Defines the granularity of the returned Isoline.
MaxPoints -> (integer)
MaxResolution -> (long)
Maximum resolution of the returned isoline.
meters
Shorthand Syntax:
MaxPoints=integer,MaxResolution=long
JSON Syntax:
{
"MaxPoints": integer,
"MaxResolution": long
}
--key (string)
--optimize-isoline-for (string)
Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.
Default Value: BalancedCalculation
Possible values:
AccurateCalculationBalancedCalculationFastCalculation
--optimize-routing-for (string)
Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
Possible values:
FastestRouteShortestRoute
--origin (list)
The start position for the route.
(double)
Syntax:
double double ...
--origin-options (structure)
Origin related options.
AvoidActionsForDistance -> (long)
Heading -> (double)
Matching -> (structure)
Options to configure matching the provided position to the road network.
NameHint -> (string)
OnRoadThreshold -> (long)
If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
meters
Radius -> (long)
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Meters
Strategy -> (string)
SideOfStreet -> (structure)
Options to configure matching the provided position to a side of the street.
Position -> (list)
Position defined as [longitude, latitude] .
(double)
UseWith -> (string)
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
Default Value: 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)
Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.
You incur a calculation charge for each threshold. Using a large amount of thresholds in a request can lead you to incur unexpected charges. See Amazon Location’s pricing page <https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html>`__ for more information.
Distance -> (list)
Distance to be used for the isoline calculation.
(long)
Time -> (list)
Time to be used for the isoline calculation.
(long)
Shorthand Syntax:
Distance=long,long,Time=long,long
JSON Syntax:
{
"Distance": [long, ...],
"Time": [long, ...]
}
--traffic (structure)
Traffic related options.
FlowEventThresholdOverride -> (long)
Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.
seconds
Usage -> (string)
Determines if traffic should be used or ignored while calculating the route.
Default Value: UseTrafficData
Shorthand Syntax:
FlowEventThresholdOverride=long,Usage=string
JSON Syntax:
{
"FlowEventThresholdOverride": long,
"Usage": "IgnoreTrafficData"|"UseTrafficData"
}
--travel-mode (string)
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Note
The modeScooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.Default Value: Car
Possible values:
CarPedestrianScooterTruck
--travel-mode-options (structure)
Travel mode related options for the provided travel mode.
Car -> (structure)
Travel mode options when the provided travel mode is “Car”
EngineType -> (string)
LicensePlate -> (structure)
The vehicle License Plate.
LastCharacter -> (string)
MaxSpeed -> (double)
Maximum speed.
KilometersPerHour
Occupancy -> (integer)
The number of occupants in the vehicle.
Default Value: 1
Scooter -> (structure)
Travel mode options when the provided travel mode is Scooter
Note
When travel mode is set toScooter , then the avoidance option ControlledAccessHighways defaults to true .EngineType -> (string)
LicensePlate -> (structure)
The vehicle License Plate.
LastCharacter -> (string)
MaxSpeed -> (double)
Maximum speed specified.
KilometersPerHour
Occupancy -> (integer)
The number of occupants in the vehicle.
Default Value: 1
Truck -> (structure)
Travel mode options when the provided travel mode is “Truck”
AxleCount -> (integer)
EngineType -> (string)
GrossWeight -> (long)
Gross weight of the vehicle including trailers, and goods at capacity.
Kilograms
HazardousCargos -> (list)
List of Hazardous cargo contained in the vehicle.
(string)
Height -> (long)
Height of the vehicle.
centimeters
HeightAboveFirstAxle -> (long)
Height of the vehicle above its first axle.
centimeters
KpraLength -> (long)
Kingpin to rear axle length of the vehicle.
centimeters
Length -> (long)
Length of the vehicle.
centimeters
LicensePlate -> (structure)
The vehicle License Plate.
LastCharacter -> (string)
MaxSpeed -> (double)
Maximum speed specified.
KilometersPerHour
Occupancy -> (integer)
The number of occupants in the vehicle.
Default Value: 1
PayloadCapacity -> (long)
Payload capacity of the vehicle and trailers attached.
kilograms
TireCount -> (integer)
Trailer -> (structure)
Trailer options corresponding to the vehicle.
AxleCount -> (integer)
TrailerCount -> (integer)
Number of trailers attached to the vehicle.
Default Value: 0
TruckType -> (string)
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
WeightPerAxle -> (long)
Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.
Kilograms
WeightPerAxleGroup -> (structure)
Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.
Kilograms
Single -> (long)
Weight for single axle group.
Kilograms
Tandem -> (long)
Weight for tandem axle group.
Kilograms
Triple -> (long)
Weight for triple axle group.
Kilograms
Quad -> (long)
Weight for quad axle group.
Kilograms
Quint -> (long)
Weight for quad quint group.
Kilograms
Width -> (long)
Width of the vehicle.
centimeters
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
--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.
Output
ArrivalTime -> (string)
Time of arrival at the destination. This parameter is returned only if the Destination parameters was 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
DepartureTime -> (string)
Time of departure from thr origin.
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
IsolineGeometryFormat -> (string)
The format of the returned IsolineGeometry.
Default Value:FlexiblePolyline
Isolines -> (list)
Calculated isolines and associated properties.
(structure)
Calculated isolines and associated properties.
Connections -> (list)
Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.
(structure)
Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.
FromPolygonIndex -> (integer)
Isoline[].Geometries .Geometry -> (structure)
The isoline geometry.
LineString -> (list)
An ordered list of positions used to plot a route on a map.
Note
LineString and Polyline are mutually exclusive properties.(list)
Polyline -> (string)
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.ToPolygonIndex -> (integer)
Isoline[].Geometries .DistanceThreshold -> (long)
Geometries -> (list)
Geometries for the Calculated isolines.
(structure)
Geometry of the connection between different Isoline components.
Polygon -> (list)
A list of Isoline Polygons, for each isoline polygon, it contains polygons of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings).
(list)
(list)
PolylinePolygon -> (list)
A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md .
(string)
TimeThreshold -> (long)
PricingBucket -> (string)
SnappedDestination -> (list)
Snapped destination that was used for the Isoline calculation.
(double)
SnappedOrigin -> (list)
Snapped origin that was used for the Isoline calculation.
(double)
© Copyright 2025, Amazon Web Services. Created using Sphinx.