AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Location Service Routes V2 CalculateIsolines API operation.

Syntax

Get-GEORIsoline
-Avoid_Area <IsolineAvoidanceArea[]>
-ArrivalTime <String>
-DestinationOptions_AvoidActionsForDistance <Int64>
-OriginOptions_AvoidActionsForDistance <Int64>
-Truck_AxleCount <Int32>
-Trailer_AxleCount <Int32>
-Avoid_CarShuttleTrain <Boolean>
-Avoid_ControlledAccessHighway <Boolean>
-DepartNow <Boolean>
-DepartureTime <String>
-Destination <Double[]>
-Avoid_DirtRoad <Boolean>
-Thresholds_Distance <Int64[]>
-Car_EngineType <IsolineEngineType>
-Scooter_EngineType <IsolineEngineType>
-Truck_EngineType <IsolineEngineType>
-Avoid_Ferry <Boolean>
-Traffic_FlowEventThresholdOverride <Int64>
-Truck_GrossWeight <Int64>
-Truck_HazardousCargo <String[]>
-DestinationOptions_Heading <Double>
-OriginOptions_Heading <Double>
-Truck_Height <Int64>
-Truck_HeightAboveFirstAxle <Int64>
-Allow_Hot <Boolean>
-Allow_Hov <Boolean>
-IsolineGeometryFormat <GeometryFormat>
-Key <String>
-Truck_KpraLength <Int64>
-TravelModeOptions_Car_LicensePlate_LastCharacter <String>
-TravelModeOptions_Scooter_LicensePlate_LastCharacter <String>
-TravelModeOptions_Truck_LicensePlate_LastCharacter <String>
-Truck_Length <Int64>
-IsolineGranularity_MaxPoint <Int32>
-IsolineGranularity_MaxResolution <Int64>
-Car_MaxSpeed <Double>
-Scooter_MaxSpeed <Double>
-Truck_MaxSpeed <Double>
-DestinationOptions_Matching_NameHint <String>
-OriginOptions_Matching_NameHint <String>
-Car_Occupancy <Int32>
-Scooter_Occupancy <Int32>
-Truck_Occupancy <Int32>
-DestinationOptions_Matching_OnRoadThreshold <Int64>
-OriginOptions_Matching_OnRoadThreshold <Int64>
-OptimizeIsolineFor <IsolineOptimizationObjective>
-OptimizeRoutingFor <RoutingObjective>
-Origin <Double[]>
-Truck_PayloadCapacity <Int64>
-DestinationOptions_SideOfStreet_Position <Double[]>
-OriginOptions_SideOfStreet_Position <Double[]>
-WeightPerAxleGroup_Quad <Int64>
-WeightPerAxleGroup_Quint <Int64>
-DestinationOptions_Matching_Radius <Int64>
-OriginOptions_Matching_Radius <Int64>
-Avoid_SeasonalClosure <Boolean>
-WeightPerAxleGroup_Single <Int64>
-DestinationOptions_Matching_Strategy <MatchingStrategy>
-OriginOptions_Matching_Strategy <MatchingStrategy>
-WeightPerAxleGroup_Tandem <Int64>
-Thresholds_Time <Int64[]>
-Truck_TireCount <Int32>
-Avoid_TollRoad <Boolean>
-Avoid_TollTransponder <Boolean>
-Trailer_TrailerCount <Int32>
-TravelMode <IsolineTravelMode>
-WeightPerAxleGroup_Triple <Int64>
-Avoid_TruckRoadType <String[]>
-Truck_TruckType <IsolineTruckType>
-Truck_TunnelRestrictionCode <String>
-Avoid_Tunnel <Boolean>
-Traffic_Usage <TrafficUsage>
-DestinationOptions_SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
-OriginOptions_SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
-Avoid_UTurn <Boolean>
-Truck_WeightPerAxle <Int64>
-Truck_Width <Int64>
-Avoid_ZoneCategory <IsolineAvoidanceZoneCategory[]>
-Select <String>
-ClientConfig <AmazonGeoRoutesConfig>

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
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.

Parameters

-Allow_Hot <Boolean>
When true, allows the use of HOT (high-occupancy toll) lanes, which may affect travel times and reachable areas.Default value: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Allow_Hov <Boolean>
When true, allows the use of HOV (high-occupancy vehicle) lanes, which may affect travel times and reachable areas.Default value: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ArrivalTime <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:mmExamples:2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_Areas
-Avoid_CarShuttleTrain <Boolean>
Indicates a preference to avoid car shuttle trains (auto trains) where possible. These may still be included if no reasonable alternative route exists.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_CarShuttleTrains
-Avoid_ControlledAccessHighway <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_ControlledAccessHighways
-Avoid_DirtRoad <Boolean>
Indicates a preference to avoid unpaved or dirt roads where possible. Routes may still include dirt roads if no reasonable paved alternative exists.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_DirtRoads
-Avoid_Ferry <Boolean>
Indicates a preference to avoid ferries where possible. If a viable route cannot be calculated without using ferries, they may still be included.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_Ferries
-Avoid_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Avoid_TollRoad <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_TollRoads
-Avoid_TollTransponder <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_TollTransponders
-Avoid_TruckRoadType <String[]>
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.There are currently no other supported values as of 26th April 2024. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_TruckRoadTypes
-Avoid_Tunnel <Boolean>
Indicates a preference to avoid tunnels where possible. If a viable route cannot be calculated without using tunnels, they may still be included.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_Tunnels
-Avoid_UTurn <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_UTurns
-Avoid_ZoneCategory <IsolineAvoidanceZoneCategory[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_ZoneCategories
-Car_EngineType <IsolineEngineType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Car_EngineType
-Car_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Car_MaxSpeed
-Car_Occupancy <Int32>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Car_Occupancy
-ClientConfig <AmazonGeoRoutesConfig>
Amazon.PowerShell.Cmdlets.GEOR.AmazonGeoRoutesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DepartNow <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DepartureTime <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:mmExamples:2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Destination <Double[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_AvoidActionsForDistance <Int64>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Matching_NameHint <String>
The expected street name near the point. Helps disambiguate matching when multiple roads are within range.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Matching_OnRoadThreshold <Int64>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Matching_Radius <Int64>
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 StrategyUnit: meters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Matching_Strategy <MatchingStrategy>
Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_SideOfStreet_Position <Double[]>
The [longitude, latitude] coordinates of the point that should be matched to a specific side of the street. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsolineGeometryFormat <GeometryFormat>
The format of the returned IsolineGeometry. Default value:FlexiblePolyline
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsolineGranularity_MaxPoint <Int32>
The maximum number of points used to define each isoline. Higher values create smoother, more detailed shapes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIsolineGranularity_MaxPoints
-IsolineGranularity_MaxResolution <Int64>
The maximum distance in meters between points along the isoline. Smaller values create more detailed shapes.Unit: meters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Key <String>
An Amazon Location Service API Key with access to this action. If omitted, the request must be signed using Signature Version 4.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptimizeIsolineFor <IsolineOptimizationObjective>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptimizeRoutingFor <RoutingObjective>
Determines whether routes prioritize shortest travel time (FastestRoute) or shortest physical distance (ShortestRoute) when calculating reachable areas.Default value: FastestRoute
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Origin <Double[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_AvoidActionsForDistance <Int64>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_Matching_NameHint <String>
The expected street name near the point. Helps disambiguate matching when multiple roads are within range.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_Matching_OnRoadThreshold <Int64>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_Matching_Radius <Int64>
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 StrategyUnit: meters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_Matching_Strategy <MatchingStrategy>
Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_SideOfStreet_Position <Double[]>
The [longitude, latitude] coordinates of the point that should be matched to a specific side of the street. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Scooter_EngineType <IsolineEngineType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Scooter_EngineType
-Scooter_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Scooter_MaxSpeed
-Scooter_Occupancy <Int32>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Scooter_Occupancy
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GeoRoutes.Model.CalculateIsolinesResponse). Specifying the name of a property of type Amazon.GeoRoutes.Model.CalculateIsolinesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Thresholds_Distance <Int64[]>
List of travel distances in meters. For example, [1000, 2000, 5000] would calculate areas reachable within 1, 2, and 5 kilometers. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Thresholds_Time <Int64[]>
List of travel times in seconds. For example, [300, 600, 900] would calculate areas reachable within 5, 10, and 15 minutes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Traffic_FlowEventThresholdOverride <Int64>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Traffic_Usage <TrafficUsage>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Trailer_AxleCount <Int32>
The total number of axles across all trailers. Used for weight distribution calculations and road restrictions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Trailer_AxleCount
-Trailer_TrailerCount <Int32>
The number of trailers being pulled. Affects which roads can be used based on local regulations.Default value: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Trailer_TrailerCount
-TravelMode <IsolineTravelMode>
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
The mode Scooter also applies to motorcycles; set this to Scooter when calculating isolines for motorcycles.Default value: Car
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TravelModeOptions_Car_LicensePlate_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TravelModeOptions_Scooter_LicensePlate_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TravelModeOptions_Truck_LicensePlate_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Truck_AxleCount <Int32>
The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_AxleCount
-Truck_EngineType <IsolineEngineType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_EngineType
-Truck_GrossWeight <Int64>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_GrossWeight
-Truck_HazardousCargo <String[]>
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
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_HazardousCargos
-Truck_Height <Int64>
The vehicle height in centimeters. Used to avoid routes with low bridges or other height restrictions.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Height
-Truck_HeightAboveFirstAxle <Int64>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_HeightAboveFirstAxle
-Truck_KpraLength <Int64>
The kingpin to rear axle (KPRA) length in centimeters. Used to determine if the vehicle can safely navigate turns and intersections.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_KpraLength
-Truck_Length <Int64>
The total vehicle length in centimeters. Used to avoid roads with length restrictions and determine if the vehicle can safely navigate turns.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Length
-Truck_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_MaxSpeed
-Truck_Occupancy <Int32>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Occupancy
-Truck_PayloadCapacity <Int64>
The maximum cargo weight in kilograms that the vehicle (including attached trailers) is rated to carry.Unit: kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_PayloadCapacity
-Truck_TireCount <Int32>
The total number of tires on the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_TireCount
-Truck_TruckType <IsolineTruckType>
The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_TruckType
-Truck_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_TunnelRestrictionCode
-Truck_WeightPerAxle <Int64>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxle
-Truck_Width <Int64>
The vehicle width in centimeters. Used to avoid routes with width restrictions.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Width
-WeightPerAxleGroup_Quad <Int64>
Total weight in kilograms for quad (four adjacent) axle configurations.Unit: kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Quad
-WeightPerAxleGroup_Quint <Int64>
Total weight in kilograms for quint (five adjacent) axle configurations.Unit: kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Quint
-WeightPerAxleGroup_Single <Int64>
Total weight in kilograms for single axle configurations.Unit: kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Single
-WeightPerAxleGroup_Tandem <Int64>
Total weight in kilograms for tandem (two adjacent) axle configurations.Unit: kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Tandem
-WeightPerAxleGroup_Triple <Int64>
Total weight in kilograms for triple (three adjacent) axle configurations.Unit: kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Triple

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.GeoRoutes.Model.CalculateIsolinesResponse object containing multiple properties.

Supported Version

AWS Tools for PowerShell: 2.x.y.z