Skip to main content

route_matrixes

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

Overview​

Nameroute_matrixes
TypeResource
Idaws.geo_routes.route_matrixes

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_route_matrixexecregion, Destinations, OriginskeyUse 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. For more information, see Calculate route matrix 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​

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. For more information, see Calculate route matrix in the Amazon Location Service Developer Guide.

EXEC aws.geo_routes.route_matrixes.calculate_route_matrix
@region='{{ region }}' --required,
@key='{{ key }}'
@@json=
'{
"Allow": "{{ Allow }}",
"Avoid": "{{ Avoid }}",
"DepartNow": {{ DepartNow }},
"DepartureTime": "{{ DepartureTime }}",
"Destinations": "{{ Destinations }}",
"Exclude": "{{ Exclude }}",
"OptimizeRoutingFor": "{{ OptimizeRoutingFor }}",
"Origins": "{{ Origins }}",
"RoutingBoundary": "{{ RoutingBoundary }}",
"Traffic": "{{ Traffic }}",
"TravelMode": "{{ TravelMode }}",
"TravelModeOptions": "{{ TravelModeOptions }}"
}'
;