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

Syntax

Get-GEOROptimizedWaypoint
-Clustering_Algorithm <WaypointOptimizationClusteringAlgorithm>
-DestinationOptions_AppointmentTime <String>
-Avoid_Area <WaypointOptimizationAvoidanceArea[]>
-Avoid_CarShuttleTrain <Boolean>
-Avoid_ControlledAccessHighway <Boolean>
-Exclude_Country <String[]>
-From_DayOfWeek <DayOfWeek>
-To_DayOfWeek <DayOfWeek>
-DepartureTime <String>
-Destination <Double[]>
-Avoid_DirtRoad <Boolean>
-DrivingDistanceOptions_DrivingDistance <Int64>
-Avoid_Ferry <Boolean>
-Truck_GrossWeight <Int64>
-Truck_HazardousCargo <String[]>
-DestinationOptions_Heading <Double>
-Truck_Height <Int64>
-DestinationOptions_Id <String>
-OriginOptions_Id <String>
-Key <String>
-Truck_Length <Int64>
-OptimizeSequencingFor <WaypointOptimizationSequencingObjective>
-Origin <Double[]>
-SideOfStreet_Position <Double[]>
-RestProfile_Profile <String>
-LongCycle_RestDuration <Int64>
-ShortCycle_RestDuration <Int64>
-DestinationOptions_ServiceDuration <Int64>
-Pedestrian_Speed <Double>
-From_TimeOfDay <String>
-To_TimeOfDay <String>
-Avoid_TollRoad <Boolean>
-Trailer_TrailerCount <Int32>
-TravelMode <WaypointOptimizationTravelMode>
-Driver_TreatServiceTimeAs <WaypointOptimizationServiceTimeTreatment>
-Truck_TruckType <WaypointOptimizationTruckType>
-Truck_TunnelRestrictionCode <String>
-Avoid_Tunnel <Boolean>
-Traffic_Usage <TrafficUsage>
-SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
-Avoid_UTurn <Boolean>
-Waypoint <WaypointOptimizationWaypoint[]>
-Truck_WeightPerAxle <Int64>
-Truck_Width <Int64>
-LongCycle_WorkDuration <Int64>
-ShortCycle_WorkDuration <Int64>
-Select <String>
-ClientConfig <AmazonGeoRoutesConfig>

Description

OptimizeWaypoints calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.

Parameters

-Avoid_Area <WaypointOptimizationAvoidanceArea[]>
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>
Avoidance options for cars-shuttles-trains.
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>
Avoidance options for ferries.
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_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
-ClientConfig <AmazonGeoRoutesConfig>
Amazon.PowerShell.Cmdlets.GEOR.AmazonGeoRoutesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Clustering_Algorithm <WaypointOptimizationClusteringAlgorithm>
The algorithm to be used. DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster. TopologySegment assigns all the waypoints that are within the same topology segment into a single cluster. A Topology segment is a linear stretch of road between two junctions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DepartureTime <String>
Departure time from the waypoint.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]. 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_AppointmentTime <String>
Appointment time at the destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Heading <Double>
GPS Heading at the position.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_Id <String>
The waypoint Id.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationOptions_ServiceDuration <Int64>
Service time spent at the destination. At an appointment, the service time should be the appointment duration.Unit: seconds
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Driver_TreatServiceTimeAs <WaypointOptimizationServiceTimeTreatment>
If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DrivingDistanceOptions_DrivingDistance <Int64>
DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClustering_DrivingDistanceOptions_DrivingDistance
-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
-From_DayOfWeek <DayOfWeek>
Day of the week.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationOptions_AccessHours_From_DayOfWeek
-From_TimeOfDay <String>
Time of the day.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationOptions_AccessHours_From_TimeOfDay
-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)
-LongCycle_RestDuration <Int64>
Resting phase of the cycle.Unit: seconds
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDriver_RestCycles_LongCycle_RestDuration
-LongCycle_WorkDuration <Int64>
Working phase of the cycle.Unit: seconds
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDriver_RestCycles_LongCycle_WorkDuration
-OptimizeSequencingFor <WaypointOptimizationSequencingObjective>
Specifies the optimization criteria for the calculated sequence.Default Value: FastestRoute.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Origin <Double[]>
The start position for the route. 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)
-OriginOptions_Id <String>
The Origin Id.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Pedestrian_Speed <Double>
Walking speed.Unit: KilometersPerHour
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Pedestrian_Speed
-RestProfile_Profile <String>
Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDriver_RestProfile_Profile
-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.OptimizeWaypointsResponse). Specifying the name of a property of type Amazon.GeoRoutes.Model.OptimizeWaypointsResponse 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)
-ShortCycle_RestDuration <Int64>
Resting phase of the cycle.Unit: seconds
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDriver_RestCycles_ShortCycle_RestDuration
-ShortCycle_WorkDuration <Int64>
Working phase of the cycle.Unit: seconds
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDriver_RestCycles_ShortCycle_WorkDuration
-SideOfStreet_Position <Double[]>
Position defined as [longitude, latitude]. 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)
AliasesDestinationOptions_SideOfStreet_Position
-SideOfStreet_UseWith <SideOfStreetMatchingStrategy>
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.Default Value: DividedStreetOnly
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationOptions_SideOfStreet_UseWith
-To_DayOfWeek <DayOfWeek>
Day of the week.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationOptions_AccessHours_To_DayOfWeek
-To_TimeOfDay <String>
Time of the day.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationOptions_AccessHours_To_TimeOfDay
-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 <WaypointOptimizationTravelMode>
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)
-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_Length <Int64>
Length of the vehicle.Unit: centimeters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTravelModeOptions_Truck_Length
-Truck_TruckType <WaypointOptimizationTruckType>
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 <WaypointOptimizationWaypoint[]>
List of waypoints between the Origin and Destination. 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)
AliasesWaypoints

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.OptimizeWaypointsResponse
This cmdlet returns an Amazon.GeoRoutes.Model.OptimizeWaypointsResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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