Skip to main content

routes

Creates, updates, deletes, gets or lists a routes resource.

Overview​

Nameroutes
TypeResource
Idaws.geo_routes.routes

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:

NameAccessible byRequired ParamsOptional ParamsDescription
calculate_routesexecregion, Destination, OriginkeyCalculateRoutes computes routes given the following required parameters: Origin and Destination. For more information, see Calculate routes 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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
keystringOptional: 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​

CalculateRoutes computes routes given the following required parameters: Origin and Destination. For more information, see Calculate routes in the Amazon Location Service Developer Guide.

EXEC aws.geo_routes.routes.calculate_routes
@region='{{ region }}' --required,
@key='{{ key }}'
@@json=
'{
"Allow": "{{ Allow }}",
"ArrivalTime": "{{ ArrivalTime }}",
"Avoid": "{{ Avoid }}",
"DepartNow": {{ DepartNow }},
"DepartureTime": "{{ DepartureTime }}",
"Destination": "{{ Destination }}",
"DestinationOptions": "{{ DestinationOptions }}",
"Driver": "{{ Driver }}",
"Exclude": "{{ Exclude }}",
"InstructionsMeasurementSystem": "{{ InstructionsMeasurementSystem }}",
"Languages": "{{ Languages }}",
"LegAdditionalFeatures": "{{ LegAdditionalFeatures }}",
"LegGeometryFormat": "{{ LegGeometryFormat }}",
"MaxAlternatives": {{ MaxAlternatives }},
"OptimizeRoutingFor": "{{ OptimizeRoutingFor }}",
"Origin": "{{ Origin }}",
"OriginOptions": "{{ OriginOptions }}",
"SpanAdditionalFeatures": "{{ SpanAdditionalFeatures }}",
"Tolls": "{{ Tolls }}",
"Traffic": "{{ Traffic }}",
"TravelMode": "{{ TravelMode }}",
"TravelModeOptions": "{{ TravelModeOptions }}",
"TravelStepType": "{{ TravelStepType }}",
"Waypoints": "{{ Waypoints }}"
}'
;