Allow Hot (High Occupancy Toll) lanes while calculating the route.Default value: false
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Allow Hov (High Occupancy vehicle) lanes while calculating the route.Default value: false
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-AutoCircle_Margin <Int64>
The minimal distance, in meters, between any waypoint and the perimeter of the circle auto-defined for the boundary. Some margin is usually recommended so that the routing has enough leeway to travel from one waypoint to another optimally without conflicting with the routing boundary.The total of MaxRadius and Margin must be less than or equal to 200,000 meters.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | RoutingBoundary_Geometry_AutoCircle_Margin |
-AutoCircle_MaxRadius <Int64>
The maximum radius, in meters, that the auto-defined Circle boundary should have, before the Margin distance is added to the circle.The total of MaxRadius and Margin must be less than or equal to 200,000 meters.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | RoutingBoundary_Geometry_AutoCircle_MaxRadius |
Areas to be avoided. 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) |
| Aliases | Avoid_Areas |
Avoid car-shuttle-trains while calculating the route.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Avoid_CarShuttleTrains |
-Avoid_ControlledAccessHighway <
Boolean>
Avoid controlled access highways while calculating the route.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Avoid_ControlledAccessHighways |
Avoid dirt roads while calculating the route.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Avoid_DirtRoads |
Avoid ferries while calculating the route.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Avoid_Ferries |
Avoids roads where the specified toll transponders are the only mode of payment.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Avoid_TollRoads |
Avoids roads where the specified toll transponders are the only mode of payment.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Avoid_TollTransponders |
Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.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) |
| Aliases | Avoid_TruckRoadTypes |
Avoid tunnels while calculating the route.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Avoid_Tunnels |
Avoid U-turns for calculation on highways and motorways.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Avoid_UTurns |
Zone categories to be avoided. 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) |
| Aliases | Avoid_ZoneCategories |
Maximum speedUnit: kilometers per hour
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Car_MaxSpeed |
The number of occupants in the vehicle.Default value: 1
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Car_Occupancy |
Center of the Circle in World Geodetic System (WGS 84) format: [longitude, latitude].Example: [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847. 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) |
| Aliases | RoutingBoundary_Geometry_Circle_Center |
Radius of the Circle.Unit: metersValid Range: Minimum value of 0. Maximum value of 200000.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | RoutingBoundary_Geometry_Circle_Radius |
Amazon.PowerShell.Cmdlets.GEOR.AmazonGeoRoutesClientCmdlet.ClientConfig
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Uses the current time as the time of departure.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Time of departure from the origin.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) |
List of destinations for the route in World Geodetic System (WGS 84) format: [longitude, latitude].Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see
Routes pricing in the
Amazon Location Service Developer Guide.The maximum number of destinations depends on the routing boundary configuration:
- With RoutingBoundary.Geometry set: maximum 500 destinations
- With RoutingBoundary.Unbounded set to true: maximum 100 destinations
- For GrabMaps customers in ap-southeast-1 and ap-southeast-5: maximum 350 destinations
The total matrix size (origins × destinations) must not exceed:
- With RoutingBoundary.Geometry: 160,000
- With RoutingBoundary.Unbounded: 100
- For GrabMaps customers in ap-southeast-1 and ap-southeast-5: 122,500
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? | True |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Destinations |
List of countries to be avoided defined by two-letter or three-letter country codes. 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) |
| Aliases | Exclude_Countries |
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.Diagonal distance of the bounding box must be less than or equal to 400,000 meters. 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) |
| Aliases | RoutingBoundary_Geometry_BoundingBox |
Geometry defined as a polygon with only one linear ring. A linear ring is a closed sequence of four or more coordinates. The first and last coordinates are the same, forming a closed boundary. Each coordinate is a position in [longitude, latitude] format.The structure is an array of linear rings (only 1 allowed). Each linear ring is an array of coordinates (minimum 4), and each coordinate is an array of two doubles [longitude, latitude].Maximum distance between any two vertices must be less than or equal to 400,000 meters. 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) |
| Aliases | RoutingBoundary_Geometry_Polygon |
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Controls the trade-off between finding the shortest travel time (FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.Default value: FastestRoute
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
List of origins for the route in World Geodetic System (WGS 84) format: [longitude, latitude].Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see
Routes pricing in the
Amazon Location Service Developer Guide.The maximum number of origins depends on the routing boundary configuration:
- With RoutingBoundary.Geometry set: maximum 500 origins
- With RoutingBoundary.Unbounded set to true: maximum 15 origins
- For GrabMaps customers in ap-southeast-1 and ap-southeast-5: maximum 350 origins
The total matrix size (origins × destinations) must not exceed:
- With RoutingBoundary.Geometry: 160,000
- With RoutingBoundary.Unbounded: 100
- For GrabMaps customers in ap-southeast-1 and ap-southeast-5: 122,500
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? | True |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | Origins |
-RoutingBoundary_Unbounded <
Boolean>
No restrictions in terms of a routing boundary, and is typically used for longer routes.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Maximum speed.Unit: kilometers per hour
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Scooter_MaxSpeed |
-Scooter_Occupancy <
Int32>
The number of occupants in the vehicle.Default value: 1
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Scooter_Occupancy |
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.CalculateRouteMatrixResponse). Specifying the name of a property of type Amazon.GeoRoutes.Model.CalculateRouteMatrixResponse 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) |
-Traffic_FlowEventThresholdOverride <Int64>
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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Determines if traffic should be used or ignored while calculating the route.Default value: UseTrafficData
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-Trailer_TrailerCount <
Int32>
Number of trailers attached to the vehicle.Default value: 0
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_Trailer_TrailerCount |
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For
GrabMaps customers,
ap-southeast-1 and
ap-southeast-5 regions support only
Car,
Pedestrian, and
Scooter. Default value:
Car | Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-TravelModeOptions_Car_LicensePlate_LastCharacter <
String>
The last character of the License Plate.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-TravelModeOptions_Scooter_LicensePlate_LastCharacter <
String>
The last character of the License Plate.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-TravelModeOptions_Truck_LicensePlate_LastCharacter <
String>
The last character of the License Plate.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
Total number of axles of the vehicle.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_AxleCount |
-Truck_GrossWeight <Int64>
Gross weight of the vehicle including trailers, and goods at capacity.Unit: kilograms
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_GrossWeight |
List of Hazardous cargo contained in the vehicle. 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) |
| Aliases | TravelModeOptions_Truck_HazardousCargos |
-Truck_Height <Int64>
Height of the vehicle.Unit: centimeters
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_Height |
-Truck_KpraLength <Int64>
Kingpin to rear axle length of the vehicleUnit: centimeters
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_KpraLength |
-Truck_Length <Int64>
Length of the vehicle.Unit: centimeters
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_Length |
Maximum speedUnit: kilometers per hour
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_MaxSpeed |
The number of occupants in the vehicle.Default value: 1
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_Occupancy |
-Truck_PayloadCapacity <Int64>
Payload capacity of the vehicle and trailers attached.Unit: kilograms
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_PayloadCapacity |
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) |
| Aliases | TravelModeOptions_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) |
| Aliases | TravelModeOptions_Truck_TunnelRestrictionCode |
-Truck_WeightPerAxle <Int64>
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.Unit: kilograms
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_Truck_WeightPerAxle |
-Truck_Width <Int64>
Width of the vehicle.Unit: centimeters
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TravelModeOptions_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) |
| Aliases | TravelModeOptions_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) |
| Aliases | TravelModeOptions_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) |
| Aliases | TravelModeOptions_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) |
| Aliases | TravelModeOptions_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) |
| Aliases | TravelModeOptions_Truck_WeightPerAxleGroup_Triple |