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.
Get-LOCRoute-CalculatorName <String>-CarModeOptions_AvoidFerry <Boolean>-TruckModeOptions_AvoidFerry <Boolean>-CarModeOptions_AvoidToll <Boolean>-TruckModeOptions_AvoidToll <Boolean>-DepartNow <Boolean>-DeparturePosition <Double[]>-DepartureTime <DateTime>-DestinationPosition <Double[]>-DistanceUnit <DistanceUnit>-Dimensions_Height <Double>-IncludeLegGeometry <Boolean>-Dimensions_Length <Double>-Weight_Total <Double>-TravelMode <TravelMode>-Dimensions_Unit <DimensionUnit>-Weight_Unit <VehicleWeightUnit>-WaypointPosition <Double[][]>-Dimensions_Width <Double>-Select <String>-PassThru <SwitchParameter>
DeparturePosition
and DestinationPosition
. Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include: DepartureTime
or DepartNow
. This calculates a route based on predictive traffic data at the given time.
You can't specify both DepartureTime
and DepartNow
in a single request. Specifying both parameters returns a validation error. CarModeOptions
if traveling by Car
, or TruckModeOptions
if traveling by Truck
. Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
false
Valid Values: false
| true
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CarModeOptions_AvoidFerries |
false
Valid Values: false
| true
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CarModeOptions_AvoidTolls |
false
Valid Values: false
| true
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
[longitude, latitude]
.[-123.115, 49.285]
400 RoutesValidationException
error.Valid Values: [-180 to 180,-90 to 90]
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
400 ValidationException
error.YYYY-MM-DDThh:mm:ss.sssZ
. For example, 2020–07-2T12:15:20.000Z+01:00
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
[longitude, latitude]
.[-122.339, 47.615]
[-180 to 180,-90 to 90]
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
4.5
.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TruckModeOptions_Dimensions_Height |
15.5
.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TruckModeOptions_Dimensions_Length |
Meters
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TruckModeOptions_Dimensions_Unit |
4.5
.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TruckModeOptions_Dimensions_Width |
Kilometers
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
false
Valid Values: false
| true
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
TravelMode
you specify also determines how you specify route preferences:Car
use the CarModeOptions
parameter.Truck
use the TruckModeOptions
parameter.Car
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
false
Valid Values: false
| true
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TruckModeOptions_AvoidFerries |
false
Valid Values: false
| true
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TruckModeOptions_AvoidTolls |
DeparturePosition
[-123.115, 49.285]
, the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]
400 ValidationException
error.If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException
error.Valid Values: [-180 to 180,-90 to 90]
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WaypointPositions |
3500
.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TruckModeOptions_Weight_Total |
Kilograms
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TruckModeOptions_Weight_Unit |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z