waypoints
Creates, updates, deletes, gets or lists a waypoints resource.
Overview​
| Name | waypoints |
| Type | Resource |
| Id | aws.geo_routes.waypoints |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
optimize_waypoints | exec | region, Origin | key | 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. For more information, see Optimize waypoints in the Amazon Location Service Developer Guide. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
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. |
Lifecycle Methods​
- optimize_waypoints
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. For more information, see Optimize waypoints in the Amazon Location Service Developer Guide.
EXEC aws.geo_routes.waypoints.optimize_waypoints
@region='{{ region }}' --required,
@key='{{ key }}'
@@json=
'{
"Avoid": "{{ Avoid }}",
"Clustering": "{{ Clustering }}",
"DepartureTime": "{{ DepartureTime }}",
"Destination": "{{ Destination }}",
"DestinationOptions": "{{ DestinationOptions }}",
"Driver": "{{ Driver }}",
"Exclude": "{{ Exclude }}",
"OptimizeSequencingFor": "{{ OptimizeSequencingFor }}",
"Origin": "{{ Origin }}",
"OriginOptions": "{{ OriginOptions }}",
"Traffic": "{{ Traffic }}",
"TravelMode": "{{ TravelMode }}",
"TravelModeOptions": "{{ TravelModeOptions }}",
"Waypoints": "{{ Waypoints }}"
}'
;