roads
Creates, updates, deletes, gets or lists a roads resource.
Overview​
| Name | roads |
| Type | Resource |
| Id | aws.geo_routes.roads |
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 |
|---|---|---|---|---|
snap_to_roads | exec | region, TracePoints | key | SnapToRoads matches GPS trace to roads most likely traveled on. For more information, see Snap to Roads 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​
- snap_to_roads
SnapToRoads matches GPS trace to roads most likely traveled on. For more information, see Snap to Roads in the Amazon Location Service Developer Guide.
EXEC aws.geo_routes.roads.snap_to_roads
@region='{{ region }}' --required,
@key='{{ key }}'
@@json=
'{
"SnappedGeometryFormat": "{{ SnappedGeometryFormat }}",
"SnapRadius": {{ SnapRadius }},
"TracePoints": "{{ TracePoints }}",
"TravelMode": "{{ TravelMode }}",
"TravelModeOptions": "{{ TravelModeOptions }}"
}'
;