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

Syntax

Get-GEORRouteMatrix
-Avoid_Area <RouteMatrixAvoidanceArea[]>
-Truck_AxleCount <Int32>
-Geometry_BoundingBox <Double[]>
-Avoid_CarShuttleTrain <Boolean>
-Circle_Center <Double[]>
-Avoid_ControlledAccessHighway <Boolean>
-Exclude_Country <String[]>
-DepartNow <Boolean>
-DepartureTime <String>
-Destination <RouteMatrixDestination[]>
-Avoid_DirtRoad <Boolean>
-Avoid_Ferry <Boolean>
-Traffic_FlowEventThresholdOverride <Int64>
-Truck_GrossWeight <Int64>
-Truck_HazardousCargo <String[]>
-Truck_Height <Int64>
-Allow_Hot <Boolean>
-Allow_Hov <Boolean>
-Key <String>
-Truck_KpraLength <Int64>
-TravelModeOptions_Car_LicensePlate_LastCharacter <String>
-TravelModeOptions_Scooter_LicensePlate_LastCharacter <String>
-TravelModeOptions_Truck_LicensePlate_LastCharacter <String>
-Truck_Length <Int64>
-AutoCircle_Margin <Int64>
-AutoCircle_MaxRadius <Int64>
-Car_MaxSpeed <Double>
-Scooter_MaxSpeed <Double>
-Truck_MaxSpeed <Double>
-Car_Occupancy <Int32>
-Scooter_Occupancy <Int32>
-Truck_Occupancy <Int32>
-OptimizeRoutingFor <RoutingObjective>
-Origin <RouteMatrixOrigin[]>
-Truck_PayloadCapacity <Int64>
-Geometry_Polygon <Double[][][]>
-WeightPerAxleGroup_Quad <Int64>
-WeightPerAxleGroup_Quint <Int64>
-Circle_Radius <Double>
-WeightPerAxleGroup_Single <Int64>
-WeightPerAxleGroup_Tandem <Int64>
-Avoid_TollRoad <Boolean>
-Avoid_TollTransponder <Boolean>
-Trailer_TrailerCount <Int32>
-TravelMode <RouteMatrixTravelMode>
-WeightPerAxleGroup_Triple <Int64>
-Avoid_TruckRoadType <String[]>
-Truck_TruckType <RouteMatrixTruckType>
-Truck_TunnelRestrictionCode <String>
-Avoid_Tunnel <Boolean>
-RoutingBoundary_Unbounded <Boolean>
-Traffic_Usage <TrafficUsage>
-Avoid_UTurn <Boolean>
-Truck_WeightPerAxle <Int64>
-Truck_Width <Int64>
-Avoid_ZoneCategory <RouteMatrixAvoidanceZoneCategory[]>
-Select <String>
-ClientConfig <AmazonGeoRoutesConfig>

Description

Use CalculateRouteMatrix to compute results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.

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)
-AutoCircle_Margin <Int64>
The margin provided for the calculation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRoutingBoundary_Geometry_AutoCircle_Margin
-AutoCircle_MaxRadius <Int64>
The maximum size of the radius provided for the calculation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRoutingBoundary_Geometry_AutoCircle_MaxRadius
-Avoid_Area <RouteMatrixAvoidanceArea[]>
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)
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_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. 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>
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 <RouteMatrixAvoidanceZoneCategory[]>
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)
AliasesAvoid_ZoneCategories
-Car_MaxSpeed <Double>
Maximum speedUnit: 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
-Circle_Center <Double[]>
Center of the Circle defined in longitude and latitude coordinates.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)
AliasesRoutingBoundary_Geometry_Circle_Center
-Circle_Radius <Double>
Radius of the Circle.Unit: meters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRoutingBoundary_Geometry_Circle_Radius
-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 <RouteMatrixDestination[]>
List of destinations for the route.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. See Amazon Location's pricing page for more information. 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)
AliasesDestinations
-Exclude_Country <String[]>
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)
AliasesExclude_Countries
-Geometry_BoundingBox <Double[]>
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. 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)
AliasesRoutingBoundary_Geometry_BoundingBox
-Geometry_Polygon <Double[][][]>
Geometry defined as a polygon with only one linear ring. 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)
AliasesRoutingBoundary_Geometry_Polygon
-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)
-OptimizeRoutingFor <RoutingObjective>
Specifies the optimization criteria for calculating a route.Default Value: FastestRoute
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Origin <RouteMatrixOrigin[]>
The position in longitude and latitude for the origin.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. See Amazon Location's pricing page for more information. 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)
AliasesOrigins
-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)
-Scooter_MaxSpeed <Double>
Maximum speed.Unit: 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.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)
-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_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 <RouteMatrixTravelMode>
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)
-Truck_AxleCount <Int32>
Total number of axles of the vehicle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_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)
AliasesTravelModeOptions_Truck_GrossWeight
-Truck_HazardousCargo <String[]>
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)
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_KpraLength <Int64>
Kingpin to rear axle length of the vehicleUnit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_KpraLength
-Truck_Length <Int64>
Length of the vehicle.Unit: centimeters
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_TruckType <RouteMatrixTruckType>
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
-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.CalculateRouteMatrixResponse
This cmdlet returns an Amazon.GeoRoutes.Model.CalculateRouteMatrixResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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