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 CalculateRoutes API operation.

Syntax

Get-GEORRoute
-Tolls_AllTransponder <Boolean>
-Tolls_AllVignette <Boolean>
-Avoid_Area <RouteAvoidanceArea[]>
-ArrivalTime <String>
-DestinationOptions_AvoidActionsForDistance <Int64>
-OriginOptions_AvoidActionsForDistance <Int64>
-DestinationOptions_AvoidUTurn <Boolean>
-OriginOptions_AvoidUTurn <Boolean>
-Truck_AxleCount <Int32>
-Trailer_AxleCount <Int32>
-Avoid_CarShuttleTrain <Boolean>
-EmissionType_Co2EmissionClass <String>
-Avoid_ControlledAccessHighway <Boolean>
-Exclude_Country <String[]>
-Tolls_Currency <String>
-DepartNow <Boolean>
-DepartureTime <String>
-Destination <Double[]>
-Avoid_DirtRoad <Boolean>
-Car_EngineType <RouteEngineType>
-Scooter_EngineType <RouteEngineType>
-Truck_EngineType <RouteEngineType>
-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>
-InstructionsMeasurementSystem <MeasurementSystem>
-Key <String>
-Truck_KpraLength <Int64>
-Language <String[]>
-TravelModeOptions_Car_LicensePlate_LastCharacter <String>
-TravelModeOptions_Scooter_LicensePlate_LastCharacter <String>
-TravelModeOptions_Truck_LicensePlate_LastCharacter <String>
-LegAdditionalFeature <String[]>
-LegGeometryFormat <GeometryFormat>
-Truck_Length <Int64>
-MaxAlternative <Int32>
-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>
-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>
-Driver_Schedule <RouteDriverScheduleInterval[]>
-Avoid_SeasonalClosure <Boolean>
-WeightPerAxleGroup_Single <Int64>
-SpanAdditionalFeature <String[]>
-Pedestrian_Speed <Double>
-DestinationOptions_StopDuration <Int64>
-DestinationOptions_Matching_Strategy <MatchingStrategy>
-OriginOptions_Matching_Strategy <MatchingStrategy>
-WeightPerAxleGroup_Tandem <Int64>
-Truck_TireCount <Int32>
-Avoid_TollRoad <Boolean>
-Avoid_TollTransponder <Boolean>
-Trailer_TrailerCount <Int32>
-TravelMode <RouteTravelMode>
-TravelStepType <RouteTravelStepType>
-WeightPerAxleGroup_Triple <Int64>
-Avoid_TruckRoadType <String[]>
-Truck_TruckType <RouteTruckType>
-Truck_TunnelRestrictionCode <String>
-Avoid_Tunnel <Boolean>
-EmissionType_Type <String>
-Traffic_Usage <TrafficUsage>
-DestinationOptions_SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
-OriginOptions_SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
-Avoid_UTurn <Boolean>
-Tolls_VehicleCategory <RouteTollVehicleCategory>
-Waypoint <RouteWaypoint[]>
-Truck_WeightPerAxle <Int64>
-Truck_Width <Int64>
-Avoid_ZoneCategory <RouteAvoidanceZoneCategory[]>
-Select <String>
-ClientConfig <AmazonGeoRoutesConfig>

Description

CalculateRoutes computes routes given the following required parameters: Origin and Destination.

Parameters

-Allow_Hot <Boolean>
Allow Hot (High Occupancy Toll) lanes while calculating the route.Default value: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Allow_Hov <Boolean>
Allow Hov (High Occupancy vehicle) lanes while calculating the route.Default value: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ArrivalTime <String>
Time of arrival at the destination.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)
-Avoid_Area <RouteAvoidanceArea[]>
Areas to be avoided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_Areas
-Avoid_CarShuttleTrain <Boolean>
Avoid car-shuttle-trains while calculating the route.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_CarShuttleTrains
-Avoid_ControlledAccessHighway <Boolean>
Avoid controlled access highways while calculating the route.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_ControlledAccessHighways
-Avoid_DirtRoad <Boolean>
Avoid dirt roads while calculating the route.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_DirtRoads
-Avoid_Ferry <Boolean>
Avoid ferries while calculating the route.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_Ferries
-Avoid_SeasonalClosure <Boolean>
Avoid roads that have seasonal closure while calculating the route.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Avoid_TollRoad <Boolean>
Avoids roads where the specified toll transponders are the only mode of payment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_TollRoads
-Avoid_TollTransponder <Boolean>
Avoids roads where the specified toll transponders are the only mode of payment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_TollTransponders
-Avoid_TruckRoadType <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_TruckRoadTypes
-Avoid_Tunnel <Boolean>
Avoid tunnels while calculating the route.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_Tunnels
-Avoid_UTurn <Boolean>
Avoid U-turns for calculation on highways and motorways.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_UTurns
-Avoid_ZoneCategory <RouteAvoidanceZoneCategory[]>
Zone categories to be avoided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvoid_ZoneCategories
-Car_EngineType <RouteEngineType>
Engine type of the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Car_EngineType
-Car_MaxSpeed <Double>
Maximum speed specified.Unit: KilometersPerHour
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Car_MaxSpeed
-Car_Occupancy <Int32>
The number of occupants in the vehicle.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>
Uses the current time as the time of departure.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DepartureTime <String>
Time of departure from thr 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)
-Destination <Double[]>
The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_AvoidActionsForDistance <Int64>
Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_AvoidUTurn <Boolean>
Avoid U-turns for calculation on highways and motorways.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationOptions_AvoidUTurns
-DestinationOptions_Heading <Double>
GPS Heading at the position.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Matching_NameHint <String>
Attempts to match the provided position to a road similar to the provided name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Matching_OnRoadThreshold <Int64>
If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.Unit: meters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Matching_Radius <Int64>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Matching_Strategy <MatchingStrategy>
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_SideOfStreet_Position <Double[]>
Position defined as [longitude, latitude].
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
Strategy that defines when the side of street position should be used.Default Value: DividedStreetOnly
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_StopDuration <Int64>
Duration of the stop.Unit: seconds
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Driver_Schedule <RouteDriverScheduleInterval[]>
Driver work-rest schedule. Stops are added to fulfil the provided rest schedule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmissionType_Co2EmissionClass <String>
The CO 2 emission classes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTolls_EmissionType_Co2EmissionClass
-EmissionType_Type <String>
Type of the emission.Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTolls_EmissionType_Type
-Exclude_Country <String[]>
List of countries to be avoided defined by two-letter or three-letter country codes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExclude_Countries
-InstructionsMeasurementSystem <MeasurementSystem>
Measurement system to be used for instructions within steps in the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Key <String>
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)
-Language <String[]>
List of languages for instructions within steps in the response.Instructions in the requested language are returned only if they are available.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLanguages
-LegAdditionalFeature <String[]>
A list of optional additional parameters such as timezone that can be requested for each result.
  • Elevation: Retrieves the elevation information for each location.
  • Incidents: Provides information on traffic incidents along the route.
  • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.
  • Summary: Returns a summary of the route, including distance and duration.
  • Tolls: Supplies toll cost information along the route.
  • TravelStepInstructions: Provides step-by-step instructions for travel along the route.
  • TruckRoadTypes: Returns information about road types suitable for trucks.
  • TypicalDuration: Gives typical travel duration based on historical data.
  • Zones: Specifies the time zone information for each waypoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLegAdditionalFeatures
-LegGeometryFormat <GeometryFormat>
Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline.Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxAlternative <Int32>
Maximum number of alternative routes to be provided in the response, if available.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxAlternatives
-OptimizeRoutingFor <RoutingObjective>
Specifies the optimization criteria for calculating a route.Default Value: FastestRoute
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Origin <Double[]>
The start position for the route.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_AvoidActionsForDistance <Int64>
Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_AvoidUTurn <Boolean>
Avoid U-turns for calculation on highways and motorways.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOriginOptions_AvoidUTurns
-OriginOptions_Heading <Double>
GPS Heading at the position.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_Matching_NameHint <String>
Attempts to match the provided position to a road similar to the provided name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_Matching_OnRoadThreshold <Int64>
If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.Unit: meters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_Matching_Radius <Int64>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_Matching_Strategy <MatchingStrategy>
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_SideOfStreet_Position <Double[]>
Position defined as [longitude, latitude].
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginOptions_SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
Strategy that defines when the side of street position should be used.Default Value: DividedStreetOnly
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Pedestrian_Speed <Double>
Walking speed in Kilometers per hour.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Pedestrian_Speed
-Scooter_EngineType <RouteEngineType>
Engine type of the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Scooter_EngineType
-Scooter_MaxSpeed <Double>
Maximum speedUnit: KilometersPerHour
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Scooter_MaxSpeed
-Scooter_Occupancy <Int32>
The number of occupants in the vehicle.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.CalculateRoutesResponse). Specifying the name of a property of type Amazon.GeoRoutes.Model.CalculateRoutesResponse 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)
-SpanAdditionalFeature <String[]>
A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSpanAdditionalFeatures
-Tolls_AllTransponder <Boolean>
Specifies if the user has valid transponder with access to all toll systems. This impacts toll calculation, and if true the price with transponders is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTolls_AllTransponders
-Tolls_AllVignette <Boolean>
Specifies if the user has valid vignettes with access for all toll roads. If a user has a vignette for a toll road, then toll cost for that road is omitted since no further payment is necessary.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTolls_AllVignettes
-Tolls_Currency <String>
Currency code corresponding to the price. This is the same as Currency specified in the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tolls_VehicleCategory <RouteTollVehicleCategory>
Vehicle category for toll cost calculation.
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)
-Traffic_Usage <TrafficUsage>
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_AxleCount <Int32>
Total number of axles of the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Trailer_AxleCount
-Trailer_TrailerCount <Int32>
Number of trailers attached to the vehicle.Default Value: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Trailer_TrailerCount
-TravelMode <RouteTravelMode>
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.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)
-TravelStepType <RouteTravelStepType>
Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Truck_AxleCount <Int32>
Total number of axles of the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_AxleCount
-Truck_EngineType <RouteEngineType>
Engine type of the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_EngineType
-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)
AliasesTravelModeOptions_Truck_GrossWeight
-Truck_HazardousCargo <String[]>
List of Hazardous cargo contained in the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_HazardousCargos
-Truck_Height <Int64>
Height of the vehicle.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Height
-Truck_HeightAboveFirstAxle <Int64>
Height of the vehicle above its first axle.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_HeightAboveFirstAxle
-Truck_KpraLength <Int64>
Kingpin to rear axle length of the vehicle.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_KpraLength
-Truck_Length <Int64>
Length of the vehicle.Unit: c
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Length
-Truck_MaxSpeed <Double>
Maximum speedUnit: KilometersPerHour
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_MaxSpeed
-Truck_Occupancy <Int32>
The number of occupants in the vehicle.Default Value: 1
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Occupancy
-Truck_PayloadCapacity <Int64>
Payload capacity of the vehicle and trailers attached.Unit: kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_PayloadCapacity
-Truck_TireCount <Int32>
Number of tires on the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_TireCount
-Truck_TruckType <RouteTruckType>
Type of the truck.
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>
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)
AliasesTravelModeOptions_Truck_WeightPerAxle
-Truck_Width <Int64>
Width of the vehicle.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Width
-Waypoint <RouteWaypoint[]>
List of waypoints between the Origin and Destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWaypoints
-WeightPerAxleGroup_Quad <Int64>
Weight for quad axle group.Unit: Kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Quad
-WeightPerAxleGroup_Quint <Int64>
Weight for quad quint group.Unit: Kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Quint
-WeightPerAxleGroup_Single <Int64>
Weight for single axle group.Unit: Kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Single
-WeightPerAxleGroup_Tandem <Int64>
Weight for tandem axle group.Unit: Kilograms
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_WeightPerAxleGroup_Tandem
-WeightPerAxleGroup_Triple <Int64>
Weight for triple axle group.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

Amazon.GeoRoutes.Model.CalculateRoutesResponse
This cmdlet returns an Amazon.GeoRoutes.Model.CalculateRoutesResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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