route_matrixes
Creates, updates, deletes, gets or lists a route_matrixes resource.
Overview​
| Name | route_matrixes |
| Type | Resource |
| Id | aws.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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
calculate_route_matrix | exec | region, Destinations, Origins | key | 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. |
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​
- calculate_route_matrix
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 }}"
}'
;