With the Amazon Location Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information.
Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:
Point-to-point routing with estimated travel time, distance, and turn-by-turn directions
Multi-point route optimization to minimize travel time or distance
Route matrices for efficient multi-destination planning
Isoline calculations to determine reachable areas within specified time or distance thresholds
Map-matching to align GPS traces with the road network
Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time.
Isolines (also known as isochrones for time-based calculations) are useful for various applications including:
Service area visualization - Show customers the area you can serve within promised delivery times
Site selection - Analyze potential business locations based on population within travel distance
Site selection - Determine areas that can be reached within specified response times
Route preferences such as avoiding toll roads or ferries are treated as preferences rather than absolute restrictions. If a viable route cannot be calculated while honoring all preferences, some may be ignored.
For more information, see Calculate isolines in the Amazon Location Service Developer Guide.
", "CalculateRouteMatrix": " 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.
", "CalculateRoutes": " CalculateRoutes computes routes given the following required parameters: Origin and Destination.
For more information, see Calculate routes in the Amazon Location Service Developer Guide.
", "OptimizeWaypoints": " 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.
", "SnapToRoads": " SnapToRoads matches GPS trace to roads most likely traveled on.
For more information, see Snap to Roads in the Amazon Location Service Developer Guide.
" }, "shapes": { "AccessDeniedException": { "base": "You don't have sufficient access to perform this action.
", "refs": {} }, "ApiKey": { "base": null, "refs": { "CalculateIsolinesRequest$Key": "An Amazon Location Service API Key with access to this action. If omitted, the request must be signed using Signature Version 4.
", "CalculateRouteMatrixRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "CalculateRoutesRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "OptimizeWaypointsRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "SnapToRoadsRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
" } }, "BeforeWaypointsList": { "base": null, "refs": { "WaypointOptimizationWaypoint$Before": "Constraint defining what waypoints are to be visited after this waypoint.
" } }, "BoundingBox": { "base": null, "refs": { "IsolineAvoidanceAreaGeometry$BoundingBox": "A rectangular area defined by its southwest and northeast corners: [min longitude, min latitude, max longitude, max latitude].
Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
", "RouteMatrixAvoidanceAreaGeometry$BoundingBox": "Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
", "RouteMatrixBoundaryGeometry$BoundingBox": "Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
", "WaypointOptimizationAvoidanceAreaGeometry$BoundingBox": "Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
" } }, "CalculateIsolinesRequest": { "base": null, "refs": {} }, "CalculateIsolinesResponse": { "base": null, "refs": {} }, "CalculateRouteMatrixRequest": { "base": null, "refs": {} }, "CalculateRouteMatrixRequestDestinationsList": { "base": null, "refs": { "CalculateRouteMatrixRequest$Destinations": "List of destinations for the route.
Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].
Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
" } }, "CalculateRoutesRequest": { "base": null, "refs": {} }, "CalculateRoutesRequestLanguagesList": { "base": null, "refs": { "CalculateRoutesRequest$Languages": " List of languages for instructions within steps in the response. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Instructions in the requested language are returned only if they are available.
Maximum number of alternative routes to be provided in the response, if available. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only up to 3 alternative routes.
Geometry defined as a circle. When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
Geometry defined as a circle. When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
Index of the cluster the waypoint is associated with. The index is included in the response only if clustering was performed while processing the request.
" } }, "Corridor": { "base": "Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
", "refs": { "IsolineAvoidanceAreaGeometry$Corridor": "A buffer zone around a line, defined by a series of coordinates and a radius in meters.
", "RouteAvoidanceAreaGeometry$Corridor": "Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
" } }, "CountryCode": { "base": null, "refs": { "CountryCodeList$member": null } }, "CountryCode3": { "base": null, "refs": { "RouteFerrySpan$Country": "3 letter Country code corresponding to the Span.
", "RoutePedestrianSpan$Country": "3 letter Country code corresponding to the Span.
", "RouteToll$Country": "The alpha-2 or alpha-3 character code for the country.
", "RouteVehicleSpan$Country": "3 letter Country code corresponding to the Span.
" } }, "CountryCodeList": { "base": null, "refs": { "RouteExclusionOptions$Countries": "List of countries to be avoided defined by two-letter or three-letter country codes.
", "RouteMatrixExclusionOptions$Countries": "List of countries to be avoided defined by two-letter or three-letter country codes.
", "WaypointOptimizationExclusionOptions$Countries": "List of countries to be avoided defined by two-letter or three-letter country codes.
" } }, "CurrencyCode": { "base": null, "refs": { "RouteTollOptions$Currency": "Currency code corresponding to the price. This is the same as Currency specified in the request.
", "RouteTollPrice$Currency": "Currency code corresponding to the price. This is the same as Currency specified in the request.
", "RouteTollPriceSummary$Currency": "Currency code corresponding to the price. This is the same as Currency specified in the request.
" } }, "DayOfWeek": { "base": null, "refs": { "WaypointOptimizationAccessHoursEntry$DayOfWeek": "Day of the week.
" } }, "DimensionCentimeters": { "base": null, "refs": { "IsolineTruckOptions$KpraLength": "The kingpin to rear axle (KPRA) length in centimeters. Used to determine if the vehicle can safely navigate turns and intersections.
Unit: centimeters
Kingpin to rear axle length of the vehicle
Unit: centimeters
Kingpin to rear axle length of the vehicle.
Unit: centimeters
The maximum height of the vehicle.
", "RouteViolatedConstraints$MaxKpraLength": "The maximum Kpra length of the vehicle.
Unit: centimeters
The maximum length of the vehicle.
", "RouteViolatedConstraints$MaxWidth": "The maximum width of the vehicle.
" } }, "DistanceMeters": { "base": null, "refs": { "Isoline$DistanceThreshold": "The travel distance in meters used to calculate this isoline, if distance-based thresholds were specified in the request.
", "IsolineDestinationOptions$AvoidActionsForDistance": "The distance in meters from the destination point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the endpoint.
", "IsolineGranularityOptions$MaxResolution": "The maximum distance in meters between points along the isoline. Smaller values create more detailed shapes.
Unit: meters
The maximum distance in meters that a point can be from a road while still being considered \"on\" that road. Points further than this distance require explicit matching.
Unit: meters
The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified Strategy
Unit: meters
The distance in meters from the origin point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the starting point.
", "OptimizeWaypointsResponse$Distance": "Overall distance to travel the whole sequence.
", "RouteFerryOverviewSummary$Distance": "Distance of the step.
", "RouteFerrySpan$Distance": "Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
Unit: meters
Distance of the step.
", "RouteMatchingOptions$OnRoadThreshold": "If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
Unit: meters
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Unit: meters
The total distance of travel for the route.
", "RouteMatrixMatchingOptions$Radius": "Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Unit: meters
Distance of the step.
", "RoutePedestrianSpan$Distance": "Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
", "RoutePedestrianTravelStep$Distance": "Distance of the step.
", "RouteSummary$Distance": "Distance of the route.
", "RouteVehicleOverviewSummary$Distance": "Distance of the step.
", "RouteVehicleSpan$Distance": "Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
", "RouteVehicleTravelStep$Distance": "Distance of the step.
", "WaypointOptimizationConnection$Distance": "Distance of the step.
", "WaypointOptimizationDrivingDistanceOptions$DrivingDistance": "DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster.
" } }, "DistanceThresholdList": { "base": null, "refs": { "IsolineThresholds$Distance": "List of travel distances in meters. For example, [1000, 2000, 5000] would calculate areas reachable within 1, 2, and 5 kilometers.
" } }, "DistanceThresholdListMemberLong": { "base": null, "refs": { "DistanceThresholdList$member": null } }, "Double": { "base": null, "refs": { "BoundingBox$member": null, "Position$member": null, "Position23$member": null } }, "DurationSeconds": { "base": null, "refs": { "Isoline$TimeThreshold": "The travel time in seconds used to calculate this isoline, if time-based thresholds were specified in the request.
", "IsolineTrafficOptions$FlowEventThresholdOverride": "The duration in seconds that real-time congestion data is considered valid before reverting to historical traffic patterns. This helps balance between using current conditions and more predictable historical data when calculating travel times.
Unit: seconds
Overall duration to travel the whole sequence.
Unit: seconds
Duration of the stop.
Unit: seconds
Maximum allowed driving time before stopping to rest.
Unit: seconds
Resting time before the driver can continue driving.
Unit: seconds
Duration of the step.
Unit: seconds
Duration of the step.
Unit: seconds
Duration of the step.
Unit: seconds
Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
Unit: seconds
Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
Unit: seconds
Duration of the step.
Unit: seconds
The expected duration of travel for the route.
Unit: seconds
Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.
", "RoutePedestrianOverviewSummary$Duration": "Duration of the step.
", "RoutePedestrianSpan$BestCaseDuration": "Duration of the computed span without traffic congestion.
Unit: seconds
Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
Unit: seconds
Duration of the computed span under typical traffic congestion.
Unit: seconds
Duration of the step.
Unit: seconds
Duration of the step.
Unit: seconds
Estimated time to turn from this span into the next.
Unit: seconds
Duration of the route.
Unit: seconds
Duration for which the price corresponds to.
Unit: seconds
Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.
", "RouteVehicleOverviewSummary$BestCaseDuration": "Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
Unit: seconds
Duration of the step.
Unit: seconds
Duration of the computed span under typical traffic congestion.
Unit: seconds
Duration of the computed span without traffic congestion.
Unit: seconds
Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
Unit: seconds
Duration of the computed span under typical traffic congestion.
Unit: seconds
Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
Unit: seconds
Duration of the step.
Unit: seconds
Duration of the computed span under typical traffic congestion.
Unit: seconds
Duration of the step.
Unit: seconds
Resting time before the driver can continue driving.
", "WaypointOptimizationConnection$TravelDuration": "Total duration.
Unit: seconds
Duration of a wait step.
Unit: seconds
Service time spent at the destination. At an appointment, the service time should be the appointment duration.
Unit: seconds
Resting phase of the cycle.
Unit: seconds
Working phase of the cycle.
Unit: seconds
Resting phase of the cycle.
Unit: seconds
Service time spent at the destination. At an appointment, the service time should be the appointment duration.
Unit: seconds
Traveling phase of the cycle.
Unit: seconds
Waiting phase of the cycle.
Unit: seconds
Service time spent at the waypoint. At an appointment, the service time should be the appointment duration.
Unit: seconds
The format of the returned IsolineGeometry.
Default value:FlexiblePolyline
The format of the returned geometries, matching the format specified in the request. Either FlexiblePolyline for compact encoding or Simple for GeoJSON-compatible coordinates.
Default value:FlexiblePolyline
Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.
FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for https://github.com/aws-geospatial/polyline.
Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.
Specifies the format of the geometry returned for each leg of the route.
", "SnapToRoadsRequest$SnappedGeometryFormat": "Chooses what the returned SnappedGeometry format should be.
Default value: FlexiblePolyline
Specifies the format of the geometry returned for each leg of the route.
" } }, "Heading": { "base": null, "refs": { "IsolineDestinationOptions$Heading": "The initial direction of travel in degrees (0-360, where 0 is north). This can affect which road segments are considered accessible from the starting point.
", "IsolineOriginOptions$Heading": "Initial direction of travel in degrees (0-360, where 0 is north). This affects which road segments are considered accessible from the starting point and is particularly useful when the origin is on a divided road or at a complex intersection.
", "RoadSnapTracePoint$Heading": "GPS Heading at the position.
", "RouteDestinationOptions$Heading": "GPS Heading at the position.
", "RouteMatrixDestinationOptions$Heading": "GPS Heading at the position.
", "RouteMatrixOriginOptions$Heading": "GPS Heading at the position.
", "RouteOriginOptions$Heading": "GPS Heading at the position.
", "RouteWaypoint$Heading": " GPS Heading at the position. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
GPS Heading at the position.
", "WaypointOptimizationWaypoint$Heading": "GPS Heading at the position.
" } }, "IndexList": { "base": null, "refs": { "RoutePedestrianSpan$Incidents": "Incidents corresponding to the span. These index into the Incidents in the parent Leg.
", "RouteToll$Systems": "Toll systems are authorities that collect payments for the toll.
", "RouteVehicleSpan$Incidents": "Incidents corresponding to the span. These index into the Incidents in the parent Leg.
", "RouteVehicleSpan$Notices": "Notices are additional information returned that indicate issues that occurred during route calculation.
", "RouteVehicleSpan$TollSystems": "Toll systems are authorities that collect payments for the toll.
", "RouteVehicleSpan$TruckRoadTypes": "Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
Zones corresponding to this leg of the route.
" } }, "Integer": { "base": null, "refs": { "Corridor$Radius": "Radius that defines the width of the corridor.
", "IndexList$member": null, "PolylineCorridor$Radius": "Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Unit: meters
The request processing has failed because of an unknown error, exception or failure.
", "refs": {} }, "Isoline": { "base": "Represents a single reachable area calculated for a specific threshold.
", "refs": { "IsolineList$member": null } }, "IsolineAllowOptions": { "base": "Special road types or features that should be considered available for routing. For example, this attribute can be used to allow the use of HOV (high-occupancy vehicle) or HOT (high-occupancy toll) lanes, even if they would otherwise not be.
", "refs": { "CalculateIsolinesRequest$Allow": "Enables special road types or features that should be considered for routing even if they might be restricted by default for the selected travel mode. These include high-occupancy vehicle and toll lanes.
" } }, "IsolineAvoidanceArea": { "base": "Defines an area to avoid when calculating routes. Consists of a primary geometry to avoid, with the ability to specify exception areas within that geometry where travel is permitted.
", "refs": { "IsolineAvoidanceAreaList$member": null } }, "IsolineAvoidanceAreaGeometry": { "base": "Defines an area to avoid during calculations using one of several supported geometry types. The service will prefer routes that avoid these areas when possible.
", "refs": { "IsolineAvoidanceArea$Geometry": "The primary area to avoid, specified using a bounding box, corridor, polygon, or polyline corridor.
", "IsolineAvoidanceAreaGeometryList$member": null } }, "IsolineAvoidanceAreaGeometryList": { "base": null, "refs": { "IsolineAvoidanceArea$Except": "Areas within the primary avoidance geometry where travel is allowed. For example, you might want to avoid a neighborhood but allow travel on a major road that passes through it.
" } }, "IsolineAvoidanceAreaGeometryPolygonList": { "base": null, "refs": { "IsolineAvoidanceAreaGeometry$Polygon": "A polygon defined by a list of coordinate rings. The first ring defines the outer boundary; subsequent rings will be ignored.
" } }, "IsolineAvoidanceAreaGeometryPolylinePolygonList": { "base": null, "refs": { "IsolineAvoidanceAreaGeometry$PolylinePolygon": "A polygon defined by encoded polyline strings. The first string defines the outer boundary; subsequent strings will be ignored. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.
" } }, "IsolineAvoidanceAreaList": { "base": null, "refs": { "IsolineAvoidanceOptions$Areas": "Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists.
" } }, "IsolineAvoidanceOptions": { "base": "Specifies features of the road network to avoid when calculating reachable areas. These preferences guide route calculations but may be overridden when no reasonable alternative exists. For example, if avoiding toll roads would make an area unreachable, toll roads may still be used.
Avoidance options include physical features (like ferries and tunnels), road characteristics (like dirt roads and highways), and regulated areas (like congestion zones). They can be combined to match specific routing needs, such as avoiding both toll roads and ferries.
", "refs": { "CalculateIsolinesRequest$Avoid": "Specifies road types, features, or areas to avoid (if possible) when calculating reachable areas. These are treated as preferences rather than strict constraints—if a route cannot be calculated without using an avoided feature, that avoidance preference may be ignored.
" } }, "IsolineAvoidanceZoneCategory": { "base": "Types of regulated zones that may affect routing.
", "refs": { "IsolineAvoidanceZoneCategoryList$member": null } }, "IsolineAvoidanceZoneCategoryList": { "base": null, "refs": { "IsolineAvoidanceOptions$ZoneCategories": "Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists.
" } }, "IsolineCarOptions": { "base": "Vehicle characteristics and preferences that affect routing for passenger cars. This includes vehicle type, occupancy, and speed restrictions that may influence which roads can be used and expected travel times.
", "refs": { "IsolineTravelModeOptions$Car": "Options specific to passenger vehicle routing (Car, such as vehicle characteristics and license plate restrictions.
The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).
Unit: kilometers per hour
The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.
Default value: 1
Represents a segment of the transportation network that connects separate parts of a reachable area. These connections show how discontinuous areas are linked, such as by ferry routes or bridges crossing unroutable terrain.
", "refs": { "IsolineConnectionList$member": null } }, "IsolineConnectionFromPolygonIndexInteger": { "base": null, "refs": { "IsolineConnection$FromPolygonIndex": "The index of the starting polygon in the isoline's Geometries list.
Represents the geometry of connections between non-contiguous parts of an isoline. These connections can be provided in either coordinate pairs (LineString) or encoded (Polyline) format, matching the format specified in the request.
", "refs": { "IsolineConnection$Geometry": "The shape of the connection, representing the actual path through the transportation network that links the polygons.
" } }, "IsolineConnectionList": { "base": null, "refs": { "Isoline$Connections": "Lines connecting separate parts of the reachable area that can be reached within the same threshold. These occur when areas are reachable but not contiguous, such as when separated by water or unroutable areas. When present, these lines represent actual transportation network segments (such as ferry routes or bridges) that connect the separated areas.
" } }, "IsolineConnectionToPolygonIndexInteger": { "base": null, "refs": { "IsolineConnection$ToPolygonIndex": "The index of the ending polygon in the isoline's Geometries list.
Options that control how the destination point is interpreted and matched to the road network when calculating reachable areas. This affects which roads are considered accessible near the destination and how the final approach is calculated.
", "refs": { "CalculateIsolinesRequest$DestinationOptions": "Options that control how the destination point is matched to the road network and how routes can approach it. These options help improve travel time accuracy by accounting for real-world access to the destination.
" } }, "IsolineEngineType": { "base": null, "refs": { "IsolineCarOptions$EngineType": "The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.
INTERNAL_COMBUSTION—Standard gasoline or diesel engine.
ELECTRIC—Battery electric vehicle.
PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.
The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.
INTERNAL_COMBUSTION—Standard gasoline or diesel engine.
ELECTRIC—Battery electric vehicle.
PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.
The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.
INTERNAL_COMBUSTION—Standard gasoline or diesel engine.
ELECTRIC—Battery electric vehicle.
PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.
Controls the detail level and smoothness of generated isolines. More detailed isolines provide better visual representation of reachable areas but require more processing time and result in larger responses.
", "refs": { "CalculateIsolinesRequest$IsolineGranularity": "Controls the detail level of the generated isolines. Higher granularity produces smoother shapes but requires more processing time and results in larger responses.
" } }, "IsolineGranularityOptionsMaxPointsInteger": { "base": null, "refs": { "IsolineGranularityOptions$MaxPoints": "The maximum number of points used to define each isoline. Higher values create smoother, more detailed shapes.
" } }, "IsolineHazardousCargoType": { "base": null, "refs": { "IsolineHazardousCargoTypeList$member": null } }, "IsolineHazardousCargoTypeList": { "base": null, "refs": { "IsolineTruckOptions$HazardousCargos": "Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.
Combustible—Materials that can burn readily
Corrosive—Materials that can destroy or irreversibly damage other substances
Explosive—Materials that can produce an explosion by chemical reaction
Flammable—Materials that can easily ignite
Gas—Hazardous materials in gaseous form
HarmfulToWater—Materials that pose a risk to water sources if released
Organic—Hazardous organic compounds
Other—Hazardous materials not covered by other categories
Poison—Toxic materials
PoisonousInhalation—Materials that are toxic when inhaled
Radioactive—Materials that emit ionizing radiation
Reachable areas, or isolines, for each threshold specified in the request.
" } }, "IsolineMatchingOptions": { "base": "Controls how origin and destination points are matched to the road network when they don't fall exactly on a road. Matching options help ensure realistic routing by connecting points to appropriate roads.
", "refs": { "IsolineDestinationOptions$Matching": "Controls how the destination point is matched to the road network, including search radius and name-based matching preferences.
", "IsolineOriginOptions$Matching": "Controls how the origin point is matched to the road network, including search radius and matching strategy.
" } }, "IsolineOptimizationObjective": { "base": null, "refs": { "CalculateIsolinesRequest$OptimizeIsolineFor": "Controls the trade-off between calculation speed and isoline precision. Choose FastCalculation for quicker results with less detail, AccurateCalculation for more precise results, or BalancedCalculation for a middle ground.
Default value: BalancedCalculation
Options that control how the origin point is interpreted when calculating reachable areas. These options affect which roads are considered accessible from the starting point and how initial routing decisions are made.
", "refs": { "CalculateIsolinesRequest$OriginOptions": "Options that control how the origin point is matched to the road network and how routes can depart from it. These options help improve travel time accuracy by accounting for real-world access from the origin.
" } }, "IsolineScooterOptions": { "base": "Vehicle characteristics that affect which roads and paths can be used when calculating reachable areas for scooters. This includes areas such as bike lanes, shared paths, and roads where scooters are permitted.
", "refs": { "IsolineTravelModeOptions$Scooter": "Options specific to scooter routing (Scooter, such as vehicle characteristics and license plate restrictions.
When using the Scooter travel mode, controlled-access highways are automatically avoided unless explicitly allowed.
The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).
Unit: kilometers per hour
The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.
Default value: 1
Represents the shape of a reachable area. The geometry can be provided either as coordinate pairs (Polygon) or in encoded format (PolylinePolygon), matching the format specified in the request.
The shapes that define the reachable area, provided in the requested geometry format.
" } }, "IsolineSideOfStreetOptions": { "base": "Controls how points are matched to specific sides of streets. This is important when the side of the street matters for accessibility - for example, when building entrances or parking lot access points can only be reached from one side of a divided road.
", "refs": { "IsolineDestinationOptions$SideOfStreet": "Specifies which side of the street should be considered accessible, which is important when building entrances or parking access points are only reachable from one side of the road.
", "IsolineOriginOptions$SideOfStreet": "Controls which side of the street is considered accessible from the origin point, particularly important for divided roads where building entrances or parking access may only be available from one direction.
" } }, "IsolineThresholds": { "base": "Specifies the time or distance limits used to calculate reachable areas. You can provide up to five thresholds for a single type to generate multiple isolines in a single request. For example, you might request areas reachable within 5, 10, and 15 minutes, or within 1, 2, and 5 kilometers.
", "refs": { "CalculateIsolinesRequest$Thresholds": "The distance or time thresholds used to determine reachable areas. You can specify up to five thresholds (which all must be the same type) to calculate multiple isolines in a single request. For example, to determine the areas that are reachable within 10 and 20 minutes of the origin, specify time thresholds of 600 and 1200 seconds.
You incur a calculation charge for each threshold. Using a large number of thresholds in a request can lead to unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
" } }, "IsolineTrafficOptions": { "base": "Controls how real-time and historical traffic data is used when calculating reachable areas. This affects both the size and shape of isolines by accounting for expected travel speeds based on congestion patterns.
", "refs": { "CalculateIsolinesRequest$Traffic": "Configures how real-time and historical traffic data affects isoline calculations. Traffic patterns can significantly impact reachable areas, especially during peak hours.
" } }, "IsolineTrailerOptions": { "base": "Additional specifications when the vehicle includes one or more trailers.
", "refs": { "IsolineTruckOptions$Trailer": "Optional specifications for attached trailers. When provided, trailer characteristics affect route calculations to ensure compliance with trailer-specific restrictions such as length limits, weight distribution requirements, and access restrictions for multi-trailer configurations.
" } }, "IsolineTrailerOptionsAxleCountInteger": { "base": null, "refs": { "IsolineTrailerOptions$AxleCount": "The total number of axles across all trailers. Used for weight distribution calculations and road restrictions.
" } }, "IsolineTrailerOptionsTrailerCountInteger": { "base": null, "refs": { "IsolineTrailerOptions$TrailerCount": "The number of trailers being pulled. Affects which roads can be used based on local regulations.
Default value: 0
The mode of transportation to use for calculations. This affects which road types or features can be used, estimated speed, and the traffic levels that are applied.
Car—Standard passenger vehicle routing using roads accessible to cars
Pedestrian—Walking routes using pedestrian paths, sidewalks, and crossings
Scooter—Light two-wheeled vehicle routing using roads and paths accessible to scooters
Truck—Commercial truck routing considering vehicle dimensions, weight restrictions, and hazardous material regulations
The mode Scooter also applies to motorcycles; set this to Scooter when calculating isolines for motorcycles.
Default value: Car
Mode-specific routing options that further refine how reachable areas are calculated. Options are only considered when they match the selected travel mode.
", "refs": { "CalculateIsolinesRequest$TravelModeOptions": "Additional attributes that refine how reachable areas are calculated based on specific vehicle characteristics. These options help produce more accurate results by accounting for real-world constraints and capabilities.
For example:
For trucks (Truck), specify dimensions, weight limits, and hazardous cargo restrictions to ensure isolines only include roads that can physically and legally accommodate the vehicle
For cars (Car), set maximum speed capabilities or indicate high-occupancy vehicle eligibility to better estimate reachable areas
For scooters (Scooter), specify engine type and speed limitations to more accurately model their travel capabilities
Without these options, calculations use default assumptions that may not match your specific use case.
" } }, "IsolineTruckOptions": { "base": "Vehicle characteristics and restrictions that affect which roads can be used when calculating reachable areas for trucks. These details ensure that routes respect physical limitations and legal requirements.
These apply when the provided travel mode is Truck
Options specific to commercial truck routing (Truck, including vehicle dimensions, weight limits, and hazardous cargo specifications.
The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.
" } }, "IsolineTruckOptionsHeightAboveFirstAxleLong": { "base": null, "refs": { "IsolineTruckOptions$HeightAboveFirstAxle": "The height in centimeters measured from the ground to the highest point above the first axle. Used for specific bridge and tunnel clearance restrictions.
Unit: centimeters
The vehicle height in centimeters. Used to avoid routes with low bridges or other height restrictions.
Unit: centimeters
The total vehicle length in centimeters. Used to avoid roads with length restrictions and determine if the vehicle can safely navigate turns.
Unit: centimeters
The maximum speed in kilometers per hour at which the vehicle can or is permitted to travel. This affects travel time calculations and may result in different reachable areas compared to using default speed limits. Value must be between 3.6 and 252 kilometers per hour.
Unit: kilometers per hour
The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.
Default value: 1
The total number of tires on the vehicle.
" } }, "IsolineTruckOptionsWidthLong": { "base": null, "refs": { "IsolineTruckOptions$Width": "The vehicle width in centimeters. Used to avoid routes with width restrictions.
Unit: centimeters
The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
License plate information used in regions where road access or routing restrictions are based on license plate numbers.
", "refs": { "IsolineCarOptions$LicensePlate": "License plate information used in regions where road access or routing restrictions are based on license plate numbers.
", "IsolineScooterOptions$LicensePlate": "License plate information used in regions where road access or routing restrictions are based on license plate numbers.
", "IsolineTruckOptions$LicensePlate": "License plate information used in regions where road access or routing restrictions are based on license plate numbers.
" } }, "IsolineVehicleLicensePlateLastCharacterString": { "base": null, "refs": { "IsolineVehicleLicensePlate$LastCharacter": "The last character of the vehicle's license plate. Used to determine road access restrictions in regions with license plate-based traffic management systems.
" } }, "IsolineZoneCategory": { "base": null, "refs": { "IsolineAvoidanceZoneCategory$Category": "The type of regulated zone: CongestionPricing for toll zones based on traffic levels, Environmental for low-emission zones, or Vignette for areas requiring special permits or stickers.
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can't be provided.
", "RouteLeg$Language": " List of languages for instructions within steps in the response. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
List of languages for instructions corresponding to the route number.
" } }, "LineString": { "base": null, "refs": { "Corridor$LineString": "An ordered list of positions used to plot a route on a map.
LineString and Polyline are mutually exclusive properties.
A series of [longitude, latitude] coordinate pairs defining the connection path when Simple geometry format is requested. These coordinates can be directly used as the coordinates array in a GeoJSON LineString without transformation.
LineString and Polyline are mutually exclusive properties.
An ordered list of positions used to plot a route on a map.
LineString and Polyline are mutually exclusive properties.
An ordered list of positions used to plot a route on a map.
LineString and Polyline are mutually exclusive properties.
A series of coordinate rings defining the reachable area when Simple geometry format is requested. Each ring is a list of [longitude, latitude] coordinate pairs. The first ring defines the outer boundary; subsequent rings define holes representing unreachable areas.
Polygon and PolylinePolygon are mutually exclusive properties.
The localized string.
", "refs": { "LocalizedStringList$member": null, "RouteMajorRoadLabel$RoadName": "Name of the road (localized).
", "RouteSignpostLabel$Text": "The Signpost text.
" } }, "LocalizedStringList": { "base": null, "refs": { "RouteContinueHighwayStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteContinueStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteEnterHighwayStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteExitStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteFerrySpan$Names": "Provides an array of names of the ferry span in available languages.
", "RouteKeepStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RoutePedestrianSpan$Names": "Provides an array of names of the pedestrian span in available languages.
", "RoutePedestrianTravelStep$ExitNumber": "Exit number of the road exit, if applicable.
", "RouteRampStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteRoad$RoadName": "Name of the road (localized).
", "RouteRoad$Towards": "Names of destinations that can be reached when traveling on the road.
", "RouteRoundaboutEnterStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteRoundaboutExitStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteRoundaboutPassStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteTurnStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteUTurnStepDetails$Intersection": "Name of the intersection, if applicable to the step.
", "RouteVehicleSpan$Names": "Provides an array of names of the vehicle span in available languages.
", "RouteVehicleTravelStep$ExitNumber": "Exit number of the road exit, if applicable.
" } }, "MatchingStrategy": { "base": null, "refs": { "IsolineMatchingOptions$Strategy": "Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
", "RouteMatrixMatchingOptions$Strategy": "Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
" } }, "MeasurementSystem": { "base": null, "refs": { "CalculateRoutesRequest$InstructionsMeasurementSystem": "Measurement system to be used for instructions within steps in the response.
" } }, "OptimizeWaypointsRequest": { "base": null, "refs": {} }, "OptimizeWaypointsResponse": { "base": null, "refs": {} }, "Polyline": { "base": null, "refs": { "IsolineConnectionGeometry$Polyline": "An encoded representation of the connection path when FlexiblePolyline geometry format is requested. This provides a more compact representation suitable for transmission and storage. To convert to GeoJSON, first decode to obtain coordinate pairs, then use those coordinates as the coordinates array in a GeoJSON LineString.
LineString and Polyline are mutually exclusive properties.
An ordered list of positions used to plot a route on a map in a lossy compression format.
LineString and Polyline are mutually exclusive properties.
An ordered list of positions used to plot a route on a map in a lossy compression format.
LineString and Polyline are mutually exclusive properties.
An ordered list of positions used to plot a route on a map in a lossy compression format.
LineString and Polyline are mutually exclusive properties.
Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
", "refs": { "IsolineAvoidanceAreaGeometry$PolylineCorridor": "A buffer zone around a compressed polyline, defined by an encoded polyline string and a radius in meters. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.
", "RouteAvoidanceAreaGeometry$PolylineCorridor": "Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
" } }, "PolylineRing": { "base": null, "refs": { "IsolineAvoidanceAreaGeometryPolylinePolygonList$member": null, "PolylineRingList$member": null, "RouteAvoidanceAreaGeometryPolylinePolygonList$member": null, "RouteMatrixAvoidanceAreaGeometryPolylinePolygonList$member": null } }, "PolylineRingList": { "base": null, "refs": { "IsolineShapeGeometry$PolylinePolygon": "An encoded representation of the reachable area when FlexiblePolyline geometry format is requested. Provides a compact representation suitable for transmission and storage. The first string defines the outer boundary; subsequent strings define holes representing unreachable areas. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.
Polygon and PolylinePolygon are mutually exclusive properties.
An optional destination point, specified as [longitude, latitude] coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either Origin or Destination must be provided.
The starting point for isoline calculations, specified as [longitude, latitude] coordinates. For example, this could be a store location, service center, or any point from which you want to calculate reachable areas. Either Origin or Destination must be provided.
The actual point on the road network used for calculations, which may differ from the requested destination if Destination was not directly on a road.
The actual point on the road network used for calculations, which may differ from the requested origin if Origin was not directly on a road.
The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].
", "Circle$Center": "Center of the Circle in World Geodetic System (WGS 84) format: [longitude, latitude].
Example: [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
The [longitude, latitude] coordinates of the point that should be matched to a specific side of the street.
The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].
The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RoadSnapSnappedTracePoint$OriginalPosition": "Position of the TracePoint provided within the request, at the same index.
", "RoadSnapSnappedTracePoint$SnappedPosition": "Snapped position of the TracePoint provided within the request, at the same index.
", "RoadSnapTracePoint$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RouteMatrixDestination$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RouteMatrixOrigin$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RouteMatrixSideOfStreetOptions$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RouteSideOfStreetOptions$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RouteWaypoint$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "WaypointOptimizationImpedingWaypoint$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "WaypointOptimizationOptimizedWaypoint$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "WaypointOptimizationSideOfStreetOptions$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "WaypointOptimizationWaypoint$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
" } }, "Position23": { "base": null, "refs": { "RouteFerryPlace$OriginalPosition": "Position provided in the request.
", "RouteFerryPlace$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RoutePassThroughPlace$OriginalPosition": "Position provided in the request.
", "RoutePassThroughPlace$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RoutePedestrianPlace$OriginalPosition": "Position provided in the request.
", "RoutePedestrianPlace$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RouteTollPaymentSite$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
", "RouteVehiclePlace$OriginalPosition": "Position provided in the request.
", "RouteVehiclePlace$Position": "Position in World Geodetic System (WGS 84) format: [longitude, latitude].
" } }, "RoadSnapHazardousCargoType": { "base": null, "refs": { "RoadSnapHazardousCargoTypeList$member": null } }, "RoadSnapHazardousCargoTypeList": { "base": null, "refs": { "RoadSnapTruckOptions$HazardousCargos": "List of Hazardous cargos contained in the vehicle.
" } }, "RoadSnapNotice": { "base": "Notices provide information around factors that may have influenced snapping in a manner atypical to the standard use cases.
", "refs": { "RoadSnapNoticeList$member": null } }, "RoadSnapNoticeCode": { "base": null, "refs": { "RoadSnapNotice$Code": "Code corresponding to the issue.
" } }, "RoadSnapNoticeList": { "base": null, "refs": { "SnapToRoadsResponse$Notices": "Notices are additional information returned that indicate issues that occurred during route calculation.
" } }, "RoadSnapSnappedGeometry": { "base": "Interpolated geometry for the snapped route that is overlay-able onto a map.
", "refs": { "SnapToRoadsResponse$SnappedGeometry": "The interpolated geometry for the snapped route onto the road network.
" } }, "RoadSnapSnappedTracePoint": { "base": "TracePoints snapped onto the road network.
", "refs": { "RoadSnapSnappedTracePointList$member": null } }, "RoadSnapSnappedTracePointConfidenceDouble": { "base": null, "refs": { "RoadSnapSnappedTracePoint$Confidence": "Confidence value for the correctness of this point match.
" } }, "RoadSnapSnappedTracePointList": { "base": null, "refs": { "SnapToRoadsResponse$SnappedTracePoints": "The trace points snapped onto the road network.
" } }, "RoadSnapTracePoint": { "base": "TracePoint indices for which the provided notice code corresponds to.
", "refs": { "SnapToRoadsRequestTracePointsList$member": null } }, "RoadSnapTracePointIndexList": { "base": null, "refs": { "RoadSnapNotice$TracePointIndexes": "TracePoint indices for which the provided notice code corresponds to.
" } }, "RoadSnapTrailerOptions": { "base": "Trailer options corresponding to the vehicle.
", "refs": { "RoadSnapTruckOptions$Trailer": "Trailer options corresponding to the vehicle.
" } }, "RoadSnapTrailerOptionsTrailerCountInteger": { "base": null, "refs": { "RoadSnapTrailerOptions$TrailerCount": "Number of trailers attached to the vehicle.
Default value: 0
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default value: Car
Travel mode related options for the provided travel mode.
", "refs": { "SnapToRoadsRequest$TravelModeOptions": "Travel mode related options for the provided travel mode.
" } }, "RoadSnapTruckOptions": { "base": "Travel mode options when the provided travel mode is Truck.
Travel mode options when the provided travel mode is Truck.
Height of the vehicle.
Unit: centimeters
Length of the vehicle.
Unit: centimeters
Width of the vehicle in centimeters.
" } }, "RoundaboutAngle": { "base": null, "refs": { "RouteRoundaboutExitStepDetails$RoundaboutAngle": "Angle of the roundabout.
" } }, "Route": { "base": "The route.
", "refs": { "RouteList$member": null } }, "RouteAllowOptions": { "base": "Features that are allowed while calculating a route.
", "refs": { "CalculateRoutesRequest$Allow": " Features that are allowed while calculating a route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Areas to be avoided.
", "refs": { "RouteAvoidanceAreaList$member": null } }, "RouteAvoidanceAreaGeometry": { "base": "Geometry of the area to be avoided.
", "refs": { "RouteAvoidanceArea$Geometry": null, "RouteAvoidanceAreaGeometryList$member": null } }, "RouteAvoidanceAreaGeometryList": { "base": null, "refs": { "RouteAvoidanceArea$Except": "Exceptions to the provided avoidance geometry, to be included while calculating the route.
" } }, "RouteAvoidanceAreaGeometryPolygonList": { "base": null, "refs": { "RouteAvoidanceAreaGeometry$Polygon": "Geometry defined as a polygon with only one linear ring.
" } }, "RouteAvoidanceAreaGeometryPolylinePolygonList": { "base": null, "refs": { "RouteAvoidanceAreaGeometry$PolylinePolygon": "A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.
" } }, "RouteAvoidanceAreaList": { "base": null, "refs": { "RouteAvoidanceOptions$Areas": " Areas to be avoided. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.
", "refs": { "CalculateRoutesRequest$Avoid": " Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only ControlledAccessHighways, Ferries, and TollRoads
Zone categories to be avoided. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Zone categories to be avoided. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Travel mode options when the provided travel mode is Car. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only LicensePlate options.
Travel mode options when the provided travel mode is Car.
Maximum speed specified. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Unit: kilometers per hour
The number of occupants in the vehicle. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Default value: 1
Details related to the continue highway step.
", "refs": { "RouteVehicleTravelStep$ContinueHighwayStepDetails": "Details that are specific to a Continue Highway step.
" } }, "RouteContinueStepDetails": { "base": "Details related to the continue step.
", "refs": { "RoutePedestrianTravelStep$ContinueStepDetails": "Details related to the continue step.
", "RouteVehicleTravelStep$ContinueStepDetails": "Details that are specific to a Continue step.
" } }, "RouteDestinationOptions": { "base": "Options related to the destination.
", "refs": { "CalculateRoutesRequest$DestinationOptions": " Destination related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
The distance in meters from the destination point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the endpoint.
" } }, "RouteDirection": { "base": null, "refs": { "RouteNumber$Direction": "Directional identifier of the route.
" } }, "RouteDriverOptions": { "base": "Driver related options.
", "refs": { "CalculateRoutesRequest$Driver": " Driver related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Interval of the driver work-rest schedule. Stops are added to fulfil the provided rest schedule.
", "refs": { "RouteDriverScheduleIntervalList$member": null } }, "RouteDriverScheduleIntervalList": { "base": null, "refs": { "RouteDriverOptions$Schedule": "Driver work-rest schedule. Stops are added to fulfil the provided rest schedule.
" } }, "RouteEmissionType": { "base": "Type of the emission.
Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev
Emission type of the vehicle for toll cost calculation.
Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev
Engine type of the vehicle. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Engine type of the vehicle. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Engine type of the vehicle.
" } }, "RouteEnterHighwayStepDetails": { "base": "Details related to the enter highway step.
", "refs": { "RouteVehicleTravelStep$EnterHighwayStepDetails": "Details that are specific to a Enter Highway step.
" } }, "RouteExclusionOptions": { "base": "Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.
", "refs": { "CalculateRoutesRequest$Exclude": " Features to be strictly excluded while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Details related to the exit step.
", "refs": { "RouteVehicleTravelStep$ExitStepDetails": "Details that are specific to a Roundabout Exit step.
" } }, "RouteExitStepDetailsRelativeExitInteger": { "base": null, "refs": { "RouteExitStepDetails$RelativeExit": "Exit to be taken.
" } }, "RouteFerryAfterTravelStep": { "base": "Steps of a leg that must be performed after the travel portion of the leg.
", "refs": { "RouteFerryAfterTravelStepList$member": null } }, "RouteFerryAfterTravelStepList": { "base": null, "refs": { "RouteFerryLegDetails$AfterTravelSteps": "Steps of a leg that must be performed after the travel portion of the leg.
" } }, "RouteFerryAfterTravelStepType": { "base": null, "refs": { "RouteFerryAfterTravelStep$Type": "Type of the step.
" } }, "RouteFerryArrival": { "base": "Details corresponding to the arrival for the leg.
", "refs": { "RouteFerryLegDetails$Arrival": "Details corresponding to the arrival for the leg.
" } }, "RouteFerryBeforeTravelStep": { "base": "Steps of a leg that must be performed before the travel portion of the leg.
", "refs": { "RouteFerryBeforeTravelStepList$member": null } }, "RouteFerryBeforeTravelStepList": { "base": null, "refs": { "RouteFerryLegDetails$BeforeTravelSteps": "Steps of a leg that must be performed before the travel portion of the leg.
" } }, "RouteFerryBeforeTravelStepType": { "base": null, "refs": { "RouteFerryBeforeTravelStep$Type": "Type of the step.
" } }, "RouteFerryDeparture": { "base": "Details corresponding to the departure for the leg.
", "refs": { "RouteFerryLegDetails$Departure": "Details corresponding to the departure for the leg.
" } }, "RouteFerryLegDetails": { "base": "FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific to ferry travel.
", "refs": { "RouteLeg$FerryLegDetails": " FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific to ferry travel. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Notices are additional information returned that indicate issues that occurred during route calculation.
", "refs": { "RouteFerryNoticeList$member": null } }, "RouteFerryNoticeCode": { "base": null, "refs": { "RouteFerryNotice$Code": "Code corresponding to the issue.
" } }, "RouteFerryNoticeList": { "base": null, "refs": { "RouteFerryLegDetails$Notices": "Notices are additional information returned that indicate issues that occurred during route calculation.
" } }, "RouteFerryOverviewSummary": { "base": "Summarized details of the leg.
", "refs": { "RouteFerrySummary$Overview": "Summarized details for the leg including before travel, travel and after travel steps.
" } }, "RouteFerryPlace": { "base": "Position provided in the request.
", "refs": { "RouteFerryArrival$Place": "The place details.
", "RouteFerryDeparture$Place": "The place details.
" } }, "RouteFerryPlaceWaypointIndexInteger": { "base": null, "refs": { "RouteFerryPlace$WaypointIndex": "Index of the waypoint in the request.
" } }, "RouteFerrySpan": { "base": "Span computed for the requested SpanAdditionalFeatures.
", "refs": { "RouteFerrySpanList$member": null } }, "RouteFerrySpanGeometryOffsetInteger": { "base": null, "refs": { "RouteFerrySpan$GeometryOffset": "Offset in the leg geometry corresponding to the start of this span.
" } }, "RouteFerrySpanList": { "base": null, "refs": { "RouteFerryLegDetails$Spans": "Spans that were computed for the requested SpanAdditionalFeatures.
" } }, "RouteFerrySpanRegionString": { "base": null, "refs": { "RouteFerrySpan$Region": "2-3 letter Region code corresponding to the Span. This is either a province or a state.
" } }, "RouteFerrySummary": { "base": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.
", "refs": { "RouteFerryLegDetails$Summary": "Summarized details of the leg.
" } }, "RouteFerryTravelOnlySummary": { "base": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.
", "refs": { "RouteFerrySummary$TravelOnly": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" } }, "RouteFerryTravelStep": { "base": "Steps of a leg that must be performed during the travel portion of the leg.
", "refs": { "RouteFerryTravelStepList$member": null } }, "RouteFerryTravelStepGeometryOffsetInteger": { "base": null, "refs": { "RouteFerryTravelStep$GeometryOffset": "Offset in the leg geometry corresponding to the start of this step.
" } }, "RouteFerryTravelStepList": { "base": null, "refs": { "RouteFerryLegDetails$TravelSteps": "Steps of a leg that must be performed before the travel portion of the leg.
" } }, "RouteFerryTravelStepType": { "base": null, "refs": { "RouteFerryTravelStep$Type": "Type of the step.
" } }, "RouteHazardousCargoType": { "base": null, "refs": { "RouteHazardousCargoTypeList$member": null } }, "RouteHazardousCargoTypeList": { "base": null, "refs": { "RouteTruckOptions$HazardousCargos": "List of Hazardous cargo contained in the vehicle.
", "RouteViolatedConstraints$HazardousCargos": "List of Hazardous cargo contained in the vehicle.
" } }, "RouteKeepStepDetails": { "base": "Details that are specific to a Keep step.
", "refs": { "RoutePedestrianTravelStep$KeepStepDetails": "Details that are specific to a Keep step.
", "RouteVehicleTravelStep$KeepStepDetails": "Details that are specific to a Keep step.
" } }, "RouteLeg": { "base": "A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.
", "refs": { "RouteLegList$member": null } }, "RouteLegAdditionalFeature": { "base": null, "refs": { "RouteLegAdditionalFeatureList$member": null } }, "RouteLegAdditionalFeatureList": { "base": null, "refs": { "CalculateRoutesRequest$LegAdditionalFeatures": " A list of optional additional parameters such as timezone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only PassThroughWaypoints, Summary, and TravelStepInstructions
Elevation: Retrieves the elevation information for each location.
Incidents: Provides information on traffic incidents along the route.
PassThroughWaypoints: Indicates waypoints that are passed through without stopping.
Summary: Returns a summary of the route, including distance and duration.
Tolls: Supplies toll cost information along the route.
TravelStepInstructions: Provides step-by-step instructions for travel along the route.
TruckRoadTypes: Returns information about road types suitable for trucks.
TypicalDuration: Gives typical travel duration based on historical data.
Zones: Specifies the time zone information for each waypoint.
The returned Route leg geometry.
", "refs": { "RouteLeg$Geometry": "Geometry of the area to be avoided.
" } }, "RouteLegList": { "base": null, "refs": { "Route$Legs": "A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.
" } }, "RouteLegTravelMode": { "base": null, "refs": { "RouteLeg$TravelMode": "Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default value: Car
Type of the leg.
" } }, "RouteList": { "base": null, "refs": { "CalculateRoutesResponse$Routes": "The path from the origin to the destination.
" } }, "RouteMajorRoadLabel": { "base": "Important labels including names and route numbers that differentiate the current route from the alternatives presented.
", "refs": { "RouteMajorRoadLabelsList$member": null } }, "RouteMajorRoadLabelsList": { "base": null, "refs": { "Route$MajorRoadLabels": "Important labels including names and route numbers that differentiate the current route from the alternatives presented.
" } }, "RouteMatchingOptions": { "base": "Options related to route matching.
", "refs": { "RouteDestinationOptions$Matching": "Options to configure matching the provided position to the road network.
", "RouteOriginOptions$Matching": "Options to configure matching the provided position to the road network.
", "RouteWaypoint$Matching": " Options to configure matching the provided position to the road network. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Attempts to match the provided position to a road similar to the provided name.
" } }, "RouteMatrix": { "base": null, "refs": { "CalculateRouteMatrixResponse$RouteMatrix": "The calculated route matrix containing the results for all pairs of Origins to Destination positions. 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 Destination positions.
" } }, "RouteMatrixAllowOptions": { "base": "Allow Options related to the route matrix.
", "refs": { "CalculateRouteMatrixRequest$Allow": "Features that are allowed while calculating a route.
" } }, "RouteMatrixAutoCircle": { "base": "Provides the circle that was used while calculating the route.
", "refs": { "RouteMatrixBoundaryGeometry$AutoCircle": "Provides the circle that was used while calculating the route.
" } }, "RouteMatrixAutoCircleMarginLong": { "base": null, "refs": { "RouteMatrixAutoCircle$Margin": "The margin provided for the calculation.
" } }, "RouteMatrixAutoCircleMaxRadiusLong": { "base": null, "refs": { "RouteMatrixAutoCircle$MaxRadius": "The maximum size of the radius provided for the calculation.
" } }, "RouteMatrixAvoidanceArea": { "base": "Area to be avoided.
", "refs": { "RouteMatrixAvoidanceOptionsAreasList$member": null } }, "RouteMatrixAvoidanceAreaGeometry": { "base": "Geometry of the area to be avoided.
", "refs": { "RouteMatrixAvoidanceArea$Geometry": "Geometry of the area to be avoided.
" } }, "RouteMatrixAvoidanceAreaGeometryPolygonList": { "base": null, "refs": { "RouteMatrixAvoidanceAreaGeometry$Polygon": "Geometry defined as a polygon with only one linear ring.
" } }, "RouteMatrixAvoidanceAreaGeometryPolylinePolygonList": { "base": null, "refs": { "RouteMatrixAvoidanceAreaGeometry$PolylinePolygon": "A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from second item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.
" } }, "RouteMatrixAvoidanceOptions": { "base": "Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.
", "refs": { "CalculateRouteMatrixRequest$Avoid": " Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only TollRoads, Ferries, and ControlledAccessHighways.
Areas to be avoided.
" } }, "RouteMatrixAvoidanceZoneCategory": { "base": "Zone categories to be avoided.
", "refs": { "RouteMatrixAvoidanceZoneCategoryList$member": null } }, "RouteMatrixAvoidanceZoneCategoryList": { "base": null, "refs": { "RouteMatrixAvoidanceOptions$ZoneCategories": "Zone categories to be avoided.
" } }, "RouteMatrixBoundary": { "base": "Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.
", "refs": { "CalculateRouteMatrixRequest$RoutingBoundary": " Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Unbounded set to true.
Default value: Unbounded set to true
When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.
When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
Geometry of the routing boundary.
", "refs": { "RouteMatrixBoundary$Geometry": "Geometry of the area to be avoided.
" } }, "RouteMatrixBoundaryGeometryPolygonList": { "base": null, "refs": { "RouteMatrixBoundaryGeometry$Polygon": "Geometry defined as a polygon with only one linear ring.
" } }, "RouteMatrixCarOptions": { "base": "Travel mode options when the provided travel mode is Car.
Travel mode options when the provided travel mode is Car.
Maximum speed
Unit: kilometers per hour
The number of occupants in the vehicle.
Default value: 1
The route destination.
", "refs": { "CalculateRouteMatrixRequestDestinationsList$member": null } }, "RouteMatrixDestinationOptions": { "base": "Options related to the destination.
", "refs": { "RouteMatrixDestination$Options": " Destination related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.
" } }, "RouteMatrixEntry": { "base": "The calculated route matrix containing the results for all pairs of Origins to Destination positions. 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 Destination positions.
", "refs": { "RouteMatrixRow$member": null } }, "RouteMatrixErrorCode": { "base": null, "refs": { "RouteMatrixEntry$Error": "Error code that occurred during calculation of the route.
" } }, "RouteMatrixExclusionOptions": { "base": "Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.
", "refs": { "CalculateRouteMatrixRequest$Exclude": " Features to be strictly excluded while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
List of Hazardous cargo contained in the vehicle.
" } }, "RouteMatrixMatchingOptions": { "base": "Matching options.
", "refs": { "RouteMatrixDestinationOptions$Matching": "Options to configure matching the provided position to the road network.
", "RouteMatrixOriginOptions$Matching": "Options to configure matching the provided position to the road network.
" } }, "RouteMatrixMatchingOptionsOnRoadThresholdLong": { "base": null, "refs": { "RouteMatrixMatchingOptions$OnRoadThreshold": "If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
Unit: meters
The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].
", "refs": { "CalculateRouteMatrixRequestOriginsList$member": null } }, "RouteMatrixOriginOptions": { "base": "Origin related options.
", "refs": { "RouteMatrixOrigin$Options": " Origin related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.
" } }, "RouteMatrixRow": { "base": null, "refs": { "RouteMatrix$member": null } }, "RouteMatrixScooterOptions": { "base": "Travel mode options when the provided travel mode is Scooter.
Travel mode options when the provided travel mode is Scooter.
When travel mode is set to Scooter, then the avoidance option ControlledAccessHighways defaults to true.
Maximum speed.
Unit: kilometers per hour
The number of occupants in the vehicle.
Default value: 1
Options to configure matching the provided position to a side of the street.
", "refs": { "RouteMatrixDestinationOptions$SideOfStreet": "Options to configure matching the provided position to a side of the street.
", "RouteMatrixOriginOptions$SideOfStreet": "Options to configure matching the provided position to a side of the street.
" } }, "RouteMatrixTrafficOptions": { "base": "Traffic related options.
", "refs": { "CalculateRouteMatrixRequest$Traffic": " Traffic related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Trailer options corresponding to the vehicle.
", "refs": { "RouteMatrixTruckOptions$Trailer": "Trailer options corresponding to the vehicle.
" } }, "RouteMatrixTrailerOptionsTrailerCountInteger": { "base": null, "refs": { "RouteMatrixTrailerOptions$TrailerCount": "Number of trailers attached to the vehicle.
Default value: 0
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Car, Pedestrian, and Scooter.
Default value: Car
Travel mode related options for the provided travel mode.
", "refs": { "CalculateRouteMatrixRequest$TravelModeOptions": " Travel mode related options for the provided travel mode. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Travel mode options when the provided travel mode is Truck.
Travel mode options when the provided travel mode is Truck.
Total number of axles of the vehicle.
" } }, "RouteMatrixTruckOptionsHeightLong": { "base": null, "refs": { "RouteMatrixTruckOptions$Height": "Height of the vehicle.
Unit: centimeters
Length of the vehicle.
Unit: centimeters
Maximum speed
Unit: kilometers per hour
The number of occupants in the vehicle.
Default value: 1
Width of the vehicle.
Unit: centimeters
The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
The vehicle License Plate.
", "refs": { "RouteMatrixCarOptions$LicensePlate": "The vehicle License Plate.
", "RouteMatrixScooterOptions$LicensePlate": "The vehicle License Plate.
", "RouteMatrixTruckOptions$LicensePlate": "The vehicle License Plate.
" } }, "RouteMatrixVehicleLicensePlateLastCharacterString": { "base": null, "refs": { "RouteMatrixVehicleLicensePlate$LastCharacter": "The last character of the License Plate.
" } }, "RouteMatrixZoneCategory": { "base": null, "refs": { "RouteMatrixAvoidanceZoneCategory$Category": "Zone category to be avoided.
" } }, "RouteNoticeDetailRange": { "base": "Notice Detail that is a range.
", "refs": { "RouteViolatedConstraints$AxleCount": "Total number of axles of the vehicle.
", "RouteViolatedConstraints$Occupancy": "The number of occupants in the vehicle.
Default value: 1
Number of trailers attached to the vehicle.
Default value: 0
Maximum value for the range.
" } }, "RouteNoticeDetailRangeMinInteger": { "base": null, "refs": { "RouteNoticeDetailRange$Min": "Minimum value for the range.
" } }, "RouteNoticeImpact": { "base": null, "refs": { "RouteFerryNotice$Impact": "Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
", "RoutePedestrianNotice$Impact": "Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
", "RouteResponseNotice$Impact": "Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
", "RouteVehicleNotice$Impact": "Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
" } }, "RouteNumber": { "base": "The route number.
", "refs": { "RouteMajorRoadLabel$RouteNumber": "Route number of the road.
", "RouteNumberList$member": null, "RouteSignpostLabel$RouteNumber": "Route number of the road.
" } }, "RouteNumberList": { "base": null, "refs": { "RoutePedestrianSpan$RouteNumbers": "Designated route name or number corresponding to the span.
", "RouteRoad$RouteNumber": "Route number of the road.
", "RouteVehicleSpan$RouteNumbers": "Designated route name or number corresponding to the span.
" } }, "RouteOriginOptions": { "base": "Origin related options.
", "refs": { "CalculateRoutesRequest$OriginOptions": " Specifies how the origin point should be matched to the road network and any routing constraints that apply when the traveler is departing the origin. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.
" } }, "RoutePassThroughPlace": { "base": "The place where the waypoint is passed through and not treated as a stop.
", "refs": { "RoutePassThroughWaypoint$Place": "The place details.
" } }, "RoutePassThroughPlaceWaypointIndexInteger": { "base": null, "refs": { "RoutePassThroughPlace$WaypointIndex": "Index of the waypoint in the request.
" } }, "RoutePassThroughWaypoint": { "base": "If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.
", "refs": { "RoutePassThroughWaypointList$member": null } }, "RoutePassThroughWaypointGeometryOffsetInteger": { "base": null, "refs": { "RoutePassThroughWaypoint$GeometryOffset": "Offset in the leg geometry corresponding to the start of this step.
" } }, "RoutePassThroughWaypointList": { "base": null, "refs": { "RouteFerryLegDetails$PassThroughWaypoints": "Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
", "RoutePedestrianLegDetails$PassThroughWaypoints": "Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
", "RouteVehicleLegDetails$PassThroughWaypoints": "Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
" } }, "RoutePedestrianArrival": { "base": "Details corresponding to the arrival for a leg.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Details corresponding to the arrival for the leg.
" } }, "RoutePedestrianDeparture": { "base": "Details corresponding to the departure for a leg.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Details corresponding to the departure for the leg.
" } }, "RoutePedestrianLegDetails": { "base": "Details that are specific to a pedestrian leg.
", "refs": { "RouteLeg$PedestrianLegDetails": "Details related to the pedestrian leg.
" } }, "RoutePedestrianNotice": { "base": "Notices are additional information returned that indicate issues that occurred during route calculation.
", "refs": { "RoutePedestrianNoticeList$member": null } }, "RoutePedestrianNoticeCode": { "base": null, "refs": { "RoutePedestrianNotice$Code": "Code corresponding to the issue.
" } }, "RoutePedestrianNoticeList": { "base": null, "refs": { "RoutePedestrianLegDetails$Notices": " Notices are additional information returned that indicate issues that occurred during route calculation. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Options related to the pedestrian. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Travel mode options when the provided travel mode is Pedestrian.
Walking speed in Kilometers per hour.
" } }, "RoutePedestrianOverviewSummary": { "base": "Provides a summary of a pedestrian route step.
", "refs": { "RoutePedestrianSummary$Overview": "Summarized details for the leg including before travel, travel and after travel steps.
" } }, "RoutePedestrianPlace": { "base": "Place details corresponding to the arrival or departure.
", "refs": { "RoutePedestrianArrival$Place": "The place details.
", "RoutePedestrianDeparture$Place": "The place details.
" } }, "RoutePedestrianPlaceWaypointIndexInteger": { "base": null, "refs": { "RoutePedestrianPlace$WaypointIndex": "Index of the waypoint in the request.
" } }, "RoutePedestrianSpan": { "base": "Span computed for the requested SpanAdditionalFeatures.
", "refs": { "RoutePedestrianSpanList$member": null } }, "RoutePedestrianSpanFunctionalClassificationInteger": { "base": null, "refs": { "RoutePedestrianSpan$FunctionalClassification": "A numerical value indicating the functional classification of the road segment corresponding to the span.
Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:
Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.
Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.
Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.
Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.
Roads with volume and traffic movement below the level of any other functional class.
Offset in the leg geometry corresponding to the start of this span.
" } }, "RoutePedestrianSpanList": { "base": null, "refs": { "RoutePedestrianLegDetails$Spans": " Spans that were computed for the requested SpanAdditionalFeatures. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
2-3 letter Region code corresponding to the Span. This is either a province or a state.
" } }, "RoutePedestrianSummary": { "base": "Summarized details for the leg including before travel, travel and after travel steps.
", "refs": { "RoutePedestrianLegDetails$Summary": "Summarized details of the leg.
" } }, "RoutePedestrianTravelOnlySummary": { "base": "Summarized details for the leg including travel steps.
", "refs": { "RoutePedestrianSummary$TravelOnly": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" } }, "RoutePedestrianTravelStep": { "base": "Steps of a leg that must be performed during the travel portion of the leg.
", "refs": { "RoutePedestrianTravelStepList$member": null } }, "RoutePedestrianTravelStepGeometryOffsetInteger": { "base": null, "refs": { "RoutePedestrianTravelStep$GeometryOffset": "Offset in the leg geometry corresponding to the start of this step.
" } }, "RoutePedestrianTravelStepList": { "base": null, "refs": { "RoutePedestrianLegDetails$TravelSteps": "Steps of a leg that must be performed before the travel portion of the leg.
" } }, "RoutePedestrianTravelStepType": { "base": null, "refs": { "RoutePedestrianTravelStep$Type": "Type of the step.
" } }, "RouteRampStepDetails": { "base": "Details that are specific to a ramp step.
", "refs": { "RouteVehicleTravelStep$RampStepDetails": "Details that are specific to a Ramp step.
" } }, "RouteResponseNotice": { "base": "Notices are additional information returned that indicate issues that occurred during route calculation.
", "refs": { "RouteResponseNoticeList$member": null } }, "RouteResponseNoticeCode": { "base": null, "refs": { "RouteResponseNotice$Code": "Code corresponding to the issue.
" } }, "RouteResponseNoticeList": { "base": null, "refs": { "CalculateRoutesResponse$Notices": " Notices are additional information returned that indicate issues that occurred during route calculation. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
The road on the route.
", "refs": { "RoutePedestrianTravelStep$CurrentRoad": "Details of the current road. See RouteRoad for details of sub-attributes.
", "RoutePedestrianTravelStep$NextRoad": "Details of the next road. See RouteRoad for details of sub-attributes.
", "RouteVehicleTravelStep$CurrentRoad": "Details of the current road.
", "RouteVehicleTravelStep$NextRoad": "Details of the next road. See RouteRoad for details of sub-attributes.
" } }, "RouteRoadType": { "base": null, "refs": { "RouteRoad$Type": "The type of road.
" } }, "RouteRoundaboutEnterStepDetails": { "base": "Details about the roundabout leg.
", "refs": { "RoutePedestrianTravelStep$RoundaboutEnterStepDetails": "Details that are specific to a Roundabout Enter step.
", "RouteVehicleTravelStep$RoundaboutEnterStepDetails": "Details that are specific to a Roundabout Enter step.
" } }, "RouteRoundaboutExitStepDetails": { "base": "Details about the roundabout step.
", "refs": { "RoutePedestrianTravelStep$RoundaboutExitStepDetails": "Details that are specific to a Roundabout Exit step.
", "RouteVehicleTravelStep$RoundaboutExitStepDetails": "Details that are specific to a Roundabout Exit step.
" } }, "RouteRoundaboutExitStepDetailsRelativeExitInteger": { "base": null, "refs": { "RouteRoundaboutExitStepDetails$RelativeExit": "Exit to be taken.
" } }, "RouteRoundaboutPassStepDetails": { "base": "Details about the step.
", "refs": { "RoutePedestrianTravelStep$RoundaboutPassStepDetails": "Details that are specific to a Roundabout Pass step.
", "RouteVehicleTravelStep$RoundaboutPassStepDetails": "Details that are specific to a Roundabout Pass step.
" } }, "RouteScooterOptions": { "base": " Travel mode options when the provided travel mode is Scooter. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only LicensePlate options.
Travel mode options when the provided travel mode is Scooter.
When travel mode is set to Scooter, then the avoidance option ControlledAccessHighways defaults to true.
Maximum speed Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Unit: kilometers per hour
The number of occupants in the vehicle. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Default value: 1
Options to configure matching the provided position to a side of the street.
", "RouteVehiclePlace$SideOfStreet": "Options to configure matching the provided position to a side of the street.
" } }, "RouteSideOfStreetOptions": { "base": "Options to configure matching the provided position to a side of the street.
", "refs": { "RouteDestinationOptions$SideOfStreet": "Options to configure matching the provided position to a side of the street.
", "RouteOriginOptions$SideOfStreet": "Options to configure matching the provided position to a side of the street.
", "RouteWaypoint$SideOfStreet": " Options to configure matching the provided position to a side of the street. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
", "refs": { "RoutePedestrianTravelStep$Signpost": "Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
", "RouteVehicleTravelStep$Signpost": "Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
" } }, "RouteSignpostLabel": { "base": "Labels presented on the sign post.
", "refs": { "RouteSignpostLabelList$member": null } }, "RouteSignpostLabelList": { "base": null, "refs": { "RouteSignpost$Labels": "Labels present on the sign post.
" } }, "RouteSpanAdditionalFeature": { "base": null, "refs": { "RouteSpanAdditionalFeatureList$member": null } }, "RouteSpanAdditionalFeatureList": { "base": null, "refs": { "CalculateRoutesRequest$SpanAdditionalFeatures": " A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Access attributes for a car corresponding to the span.
" } }, "RouteSpanDynamicSpeedDetails": { "base": "Details about the dynamic speed.
Unit: kilometers per hour
Dynamic speed details corresponding to the span.
Unit: kilometers per hour
Dynamic speed details corresponding to the span.
Unit: kilometers per hour
Attributes corresponding to a gate. The gate is present at the end of the returned span.
" } }, "RouteSpanPedestrianAccessAttribute": { "base": null, "refs": { "RouteSpanPedestrianAccessAttributeList$member": null } }, "RouteSpanPedestrianAccessAttributeList": { "base": null, "refs": { "RoutePedestrianSpan$PedestrianAccess": "Access attributes for a pedestrian corresponding to the span.
" } }, "RouteSpanRailwayCrossingAttribute": { "base": null, "refs": { "RouteVehicleSpan$RailwayCrossing": "Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
" } }, "RouteSpanRoadAttribute": { "base": null, "refs": { "RouteSpanRoadAttributeList$member": null } }, "RouteSpanRoadAttributeList": { "base": null, "refs": { "RoutePedestrianSpan$RoadAttributes": "Attributes for the road segment corresponding to the span.
", "RouteVehicleSpan$RoadAttributes": "Attributes for the road segment corresponding to the span.
" } }, "RouteSpanScooterAccessAttribute": { "base": null, "refs": { "RouteSpanScooterAccessAttributeList$member": null } }, "RouteSpanScooterAccessAttributeList": { "base": null, "refs": { "RouteVehicleSpan$ScooterAccess": "Access attributes for a scooter corresponding to the span.
" } }, "RouteSpanSpeedLimitDetails": { "base": "Details about the speed limit corresponding to the span.
Unit: kilometers per hour
Speed limit details corresponding to the span.
Unit: kilometers per hour
Speed limit details corresponding to the span.
Unit: kilometers per hour
Access attributes for a truck corresponding to the span.
" } }, "RouteSteeringDirection": { "base": null, "refs": { "RouteContinueHighwayStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteEnterHighwayStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteExitStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteKeepStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteRampStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteRoundaboutEnterStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteRoundaboutExitStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteRoundaboutPassStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteTurnStepDetails$SteeringDirection": "Steering direction for the step.
", "RouteUTurnStepDetails$SteeringDirection": "Steering direction for the step.
" } }, "RouteSummary": { "base": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.
", "refs": { "Route$Summary": "Summarized details of the leg.
" } }, "RouteToll": { "base": "Provides details about toll information along a route, including the payment sites, applicable toll rates, toll systems, and the country associated with the toll collection.
", "refs": { "RouteTollList$member": null } }, "RouteTollList": { "base": null, "refs": { "RouteVehicleLegDetails$Tolls": " Toll related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Options related to Tolls on a route.
", "refs": { "CalculateRoutesRequest$Tolls": " Toll related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Details if the toll rate can be a pass that supports multiple trips.
", "refs": { "RouteTollRate$Pass": "Details if the toll rate can be a pass that supports multiple trips.
" } }, "RouteTollPassTransferCountInteger": { "base": null, "refs": { "RouteTollPass$TransferCount": "If the toll pass can be transferred, and how many times.
" } }, "RouteTollPassTripCountInteger": { "base": null, "refs": { "RouteTollPass$TripCount": "Number of trips the pass is valid for.
" } }, "RouteTollPassValidityPeriod": { "base": "Period for which the pass is valid.
", "refs": { "RouteTollPass$ValidityPeriod": "Period for which the pass is valid.
" } }, "RouteTollPassValidityPeriodPeriodCountInteger": { "base": null, "refs": { "RouteTollPassValidityPeriod$PeriodCount": "Counts for the validity period.
" } }, "RouteTollPassValidityPeriodType": { "base": null, "refs": { "RouteTollPassValidityPeriod$Period": "Validity period.
" } }, "RouteTollPaymentMethod": { "base": null, "refs": { "RouteTollPaymentMethodList$member": null } }, "RouteTollPaymentMethodList": { "base": null, "refs": { "RouteTollRate$PaymentMethods": "Accepted payment methods at the toll.
" } }, "RouteTollPaymentSite": { "base": "Locations or sites where the toll fare is collected.
", "refs": { "RouteTollPaymentSiteList$member": null } }, "RouteTollPaymentSiteList": { "base": null, "refs": { "RouteToll$PaymentSites": "Locations or sites where the toll fare is collected.
" } }, "RouteTollPrice": { "base": "The toll price.
", "refs": { "RouteTollRate$ConvertedPrice": "Price in the converted currency as specified in the request.
", "RouteTollRate$LocalPrice": "Price in the local regional currency.
" } }, "RouteTollPriceSummary": { "base": "Summary of the route and toll price.
", "refs": { "RouteTollSummary$Total": "Total toll summary for the complete route. Total is the only summary available today.
" } }, "RouteTollPriceSummaryValueDouble": { "base": null, "refs": { "RouteTollPriceSummary$Value": "Exact price, if not a range.
" } }, "RouteTollPriceValueDouble": { "base": null, "refs": { "RouteTollPrice$Value": "Exact price, if not a range.
" } }, "RouteTollPriceValueRange": { "base": "Price range with a minimum and maximum value, if a range.
", "refs": { "RouteTollPrice$RangeValue": "Price range with a minimum and maximum value, if a range.
", "RouteTollPriceSummary$RangeValue": "Price range with a minimum and maximum value, if a range.
" } }, "RouteTollPriceValueRangeMaxDouble": { "base": null, "refs": { "RouteTollPriceValueRange$Max": "Maximum price.
" } }, "RouteTollPriceValueRangeMinDouble": { "base": null, "refs": { "RouteTollPriceValueRange$Min": "Minimum price.
" } }, "RouteTollRate": { "base": "The toll rate.
", "refs": { "RouteTollRateList$member": null } }, "RouteTollRateList": { "base": null, "refs": { "RouteToll$Rates": "Toll rates that need to be paid to travel this leg of the route.
" } }, "RouteTollSummary": { "base": "The toll summary for the complete route.
", "refs": { "RouteSummary$Tolls": "Toll summary for the complete route.
" } }, "RouteTollSystem": { "base": "Toll systems are authorities that collect payments for the toll.
", "refs": { "RouteTollSystemList$member": null } }, "RouteTollSystemList": { "base": null, "refs": { "RouteVehicleLegDetails$TollSystems": " Toll systems are authorities that collect payments for the toll. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Vehicle category for toll cost calculation.
" } }, "RouteTrafficOptions": { "base": "Traffic options for the route.
", "refs": { "CalculateRoutesRequest$Traffic": " Traffic related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Trailer options corresponding to the vehicle.
", "refs": { "RouteTruckOptions$Trailer": "Trailer options corresponding to the vehicle.
" } }, "RouteTrailerOptionsAxleCountInteger": { "base": null, "refs": { "RouteTrailerOptions$AxleCount": "Total number of axles of the vehicle.
" } }, "RouteTrailerOptionsTrailerCountInteger": { "base": null, "refs": { "RouteTrailerOptions$TrailerCount": "Number of trailers attached to the vehicle.
Default value: 0
Transponders for which this toll can be applied.
", "refs": { "RouteTransponderList$member": null } }, "RouteTransponderList": { "base": null, "refs": { "RouteTollRate$Transponders": "Transponders for which this toll can be applied.
" } }, "RouteTravelMode": { "base": null, "refs": { "CalculateRoutesRequest$TravelMode": " Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Car, Pedestrian, and Scooter values.
Default value: Car
Travel mode related options for the provided travel mode.
", "refs": { "CalculateRoutesRequest$TravelModeOptions": " Travel mode related options for the provided travel mode. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Car and Pedestrian travel mode options.
Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions Default does not return any steps.
Travel mode options when the provided travel mode is Truck. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Travel mode options when the provided travel mode is Truck.
Total number of axles of the vehicle.
" } }, "RouteTruckOptionsHeightAboveFirstAxleLong": { "base": null, "refs": { "RouteTruckOptions$HeightAboveFirstAxle": "Height of the vehicle above its first axle.
Unit: centimeters
Height of the vehicle.
Unit: centimeters
Length of the vehicle.
Unit: c
Maximum speed
Unit: kilometers per hour
The number of occupants in the vehicle.
Default value: 1
Number of tires on the vehicle.
" } }, "RouteTruckOptionsTunnelRestrictionCodeString": { "base": null, "refs": { "RouteTruckOptions$TunnelRestrictionCode": "The tunnel restriction code.
Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.
Tunnel Category B
Risk Level: Limited risk
Restrictions: Few restrictions
Tunnel Category C
Risk Level: Medium risk
Restrictions: Some restrictions
Tunnel Category D
Risk Level: High risk
Restrictions: Many restrictions occur
Tunnel Category E
Risk Level: Very high risk
Restrictions: Restricted tunnel
Width of the vehicle.
Unit: centimeters
The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
Intensity of the turn.
", "RouteEnterHighwayStepDetails$TurnIntensity": "Intensity of the turn.
", "RouteExitStepDetails$TurnIntensity": "Intensity of the turn.
", "RouteKeepStepDetails$TurnIntensity": "Intensity of the turn.
", "RouteRampStepDetails$TurnIntensity": "Intensity of the turn.
", "RouteRoundaboutEnterStepDetails$TurnIntensity": "Intensity of the turn.
", "RouteRoundaboutPassStepDetails$TurnIntensity": "Intensity of the turn.
", "RouteTurnStepDetails$TurnIntensity": "Intensity of the turn.
", "RouteUTurnStepDetails$TurnIntensity": "Intensity of the turn.
" } }, "RouteTurnStepDetails": { "base": "Details related to the turn step.
", "refs": { "RoutePedestrianTravelStep$TurnStepDetails": "Details that are specific to a turn step.
", "RouteVehicleTravelStep$TurnStepDetails": "Details that are specific to a Turn step.
" } }, "RouteUTurnStepDetails": { "base": "Details related to the U-turn step.
", "refs": { "RouteVehicleTravelStep$UTurnStepDetails": "Details that are specific to a Turn step.
" } }, "RouteVehicleArrival": { "base": "Details corresponding to the arrival for a leg.
", "refs": { "RouteVehicleLegDetails$Arrival": "Details corresponding to the arrival for the leg.
" } }, "RouteVehicleDeparture": { "base": "Details corresponding to the departure for the leg.
", "refs": { "RouteVehicleLegDetails$Departure": "Details corresponding to the departure for the leg.
" } }, "RouteVehicleIncident": { "base": "Incidents corresponding to this leg of the route.
", "refs": { "RouteVehicleIncidentList$member": null } }, "RouteVehicleIncidentList": { "base": null, "refs": { "RouteVehicleLegDetails$Incidents": " Incidents corresponding to this leg of the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Severity of the incident Critical - The part of the route the incident affects is unusable. Major- Major impact on the leg duration, for example stop and go Minor- Minor impact on the leg duration, for example traffic jam Low - Low on duration, for example slightly increased traffic
" } }, "RouteVehicleIncidentType": { "base": null, "refs": { "RouteVehicleIncident$Type": "Type of the incident.
" } }, "RouteVehicleLegDetails": { "base": "Steps of a leg that correspond to the travel portion of the leg.
", "refs": { "RouteLeg$VehicleLegDetails": "Details related to the vehicle leg.
" } }, "RouteVehicleLicensePlate": { "base": "License plate information of the vehicle. Currently, only the last character is used where license plate based controlled access is enforced.
", "refs": { "RouteCarOptions$LicensePlate": "The vehicle License Plate.
", "RouteScooterOptions$LicensePlate": "The vehicle License Plate.
", "RouteTruckOptions$LicensePlate": "The vehicle License Plate.
" } }, "RouteVehicleLicensePlateLastCharacterString": { "base": null, "refs": { "RouteVehicleLicensePlate$LastCharacter": "The last character of the License Plate.
" } }, "RouteVehicleNotice": { "base": "Notices are additional information returned that indicate issues that occurred during route calculation.
", "refs": { "RouteVehicleNoticeList$member": null } }, "RouteVehicleNoticeCode": { "base": null, "refs": { "RouteVehicleNotice$Code": "Code corresponding to the issue.
" } }, "RouteVehicleNoticeDetail": { "base": "Additional details of the notice.
", "refs": { "RouteVehicleNoticeDetailList$member": null } }, "RouteVehicleNoticeDetailList": { "base": null, "refs": { "RouteVehicleNotice$Details": "Additional details of the notice.
" } }, "RouteVehicleNoticeList": { "base": null, "refs": { "RouteVehicleLegDetails$Notices": " Notices are additional information returned that indicate issues that occurred during route calculation. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Summarized details of the leg.
", "refs": { "RouteVehicleSummary$Overview": "Summarized details for the leg including before travel, travel and after travel steps.
" } }, "RouteVehiclePlace": { "base": "Place details corresponding to the arrival or departure.
", "refs": { "RouteVehicleArrival$Place": "The place details.
", "RouteVehicleDeparture$Place": "The place details.
" } }, "RouteVehiclePlaceWaypointIndexInteger": { "base": null, "refs": { "RouteVehiclePlace$WaypointIndex": "Index of the waypoint in the request.
" } }, "RouteVehicleSpan": { "base": "Span computed for the requested SpanAdditionalFeatures.
", "refs": { "RouteVehicleSpanList$member": null } }, "RouteVehicleSpanFunctionalClassificationInteger": { "base": null, "refs": { "RouteVehicleSpan$FunctionalClassification": "A numerical value indicating the functional classification of the road segment corresponding to the span.
Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:
Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.
Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.
Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.
Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.
Roads with volume and traffic movement below the level of any other functional class.
Offset in the leg geometry corresponding to the start of this span.
" } }, "RouteVehicleSpanList": { "base": null, "refs": { "RouteVehicleLegDetails$Spans": " Spans that were computed for the requested SpanAdditionalFeatures. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
2-3 letter Region code corresponding to the Span. This is either a province or a state.
" } }, "RouteVehicleSummary": { "base": "Summarized details of the route.
", "refs": { "RouteVehicleLegDetails$Summary": "Summarized details of the leg.
" } }, "RouteVehicleTravelOnlySummary": { "base": "Summarized details of the route.
", "refs": { "RouteVehicleSummary$TravelOnly": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" } }, "RouteVehicleTravelStep": { "base": "Steps of a leg that correspond to the travel portion of the leg.
", "refs": { "RouteVehicleTravelStepList$member": null } }, "RouteVehicleTravelStepGeometryOffsetInteger": { "base": null, "refs": { "RouteVehicleTravelStep$GeometryOffset": "Offset in the leg geometry corresponding to the start of this step.
" } }, "RouteVehicleTravelStepList": { "base": null, "refs": { "RouteVehicleLegDetails$TravelSteps": "Steps of a leg that must be performed before the travel portion of the leg.
" } }, "RouteVehicleTravelStepType": { "base": null, "refs": { "RouteVehicleTravelStep$Type": "Type of the step.
" } }, "RouteViolatedConstraints": { "base": "This property contains a summary of violated constraints.
", "refs": { "RouteVehicleNoticeDetail$ViolatedConstraints": "Any violated constraints.
" } }, "RouteWaypoint": { "base": "Waypoint between the Origin and Destination.
", "refs": { "RouteWaypointList$member": null } }, "RouteWaypointAvoidActionsForDistanceLong": { "base": null, "refs": { "RouteWaypoint$AvoidActionsForDistance": " Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
List of waypoints between the Origin and Destination. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions max length is 100.
Max length: 23
Duration of the stop. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Unit: seconds
The weight constraint for the route.
Unit: kilograms
The maximum weight of the route.
Unit: kilograms
The type of constraint.
" } }, "RouteZone": { "base": "The zone.
", "refs": { "RouteZoneList$member": null } }, "RouteZoneCategory": { "base": null, "refs": { "RouteAvoidanceZoneCategory$Category": "Zone category to be avoided.
", "RouteZone$Category": "The zone category.
" } }, "RouteZoneList": { "base": null, "refs": { "RouteVehicleLegDetails$Zones": " Zones corresponding to this leg of the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Determines whether routes prioritize shortest travel time (FastestRoute) or shortest physical distance (ShortestRoute) when calculating reachable areas.
Default value: FastestRoute
Controls the trade-off between finding the shortest travel time (FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.
Default value: FastestRoute
Controls the trade-off between achieving the shortest travel time (FastestRoute) and achieving the shortest physical distance ((ShortestRoute) when calculating each route in the matrix.
Default value: FastestRoute
When true, uses the current time as the departure time and takes current traffic conditions into account. This attribute cannot be used together with DepartureTime or ArrivalTime.
Uses the current time as the time of departure.
", "CalculateRoutesRequest$DepartNow": "Uses the current time as the time of departure.
", "IsolineAllowOptions$Hot": "When true, allows the use of HOT (high-occupancy toll) lanes, which may affect travel times and reachable areas.
Default value: false
When true, allows the use of HOV (high-occupancy vehicle) lanes, which may affect travel times and reachable areas.
Default value: false
Indicates a preference to avoid car shuttle trains (auto trains) where possible. These may still be included if no reasonable alternative route exists.
", "IsolineAvoidanceOptions$ControlledAccessHighways": "Indicates a preference to avoid controlled-access highways (such as interstate highways or motorways) where possible. If a viable route cannot be calculated using only local roads, controlled-access highways may still be included.
", "IsolineAvoidanceOptions$DirtRoads": "Indicates a preference to avoid unpaved or dirt roads where possible. Routes may still include dirt roads if no reasonable paved alternative exists.
", "IsolineAvoidanceOptions$Ferries": "Indicates a preference to avoid ferries where possible. If a viable route cannot be calculated without using ferries, they may still be included.
", "IsolineAvoidanceOptions$SeasonalClosure": "Indicates a preference to avoid roads that may be subject to seasonal closures where possible. These roads may still be included if no reasonable year-round alternative exists.
", "IsolineAvoidanceOptions$TollRoads": "Indicates a preference to avoid toll roads where possible. If a viable route cannot be calculated without using toll roads, they may still be included.
", "IsolineAvoidanceOptions$TollTransponders": "Indicates a preference to avoid roads that require electronic toll collection transponders where possible. These roads may still be included if no viable alternative route exists.
", "IsolineAvoidanceOptions$Tunnels": "Indicates a preference to avoid tunnels where possible. If a viable route cannot be calculated without using tunnels, they may still be included.
", "IsolineAvoidanceOptions$UTurns": "Indicates a preference to avoid U-turns where possible. U-turns may still be included if necessary to reach certain areas or when no reasonable alternative exists.
", "RouteAllowOptions$Hot": "Allow Hot (High Occupancy Toll) lanes while calculating the route.
Default value: false
Allow Hov (High Occupancy vehicle) lanes while calculating the route.
Default value: false
Avoid car-shuttle-trains while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoid controlled access highways while calculating the route.
", "RouteAvoidanceOptions$DirtRoads": " Avoid dirt roads while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoid ferries while calculating the route.
", "RouteAvoidanceOptions$SeasonalClosure": " Avoid roads that have seasonal closure while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoids roads where the specified toll transponders are the only mode of payment.
", "RouteAvoidanceOptions$TollTransponders": " Avoids roads where the specified toll transponders are the only mode of payment. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoid tunnels while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoid U-turns for calculation on highways and motorways. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoid U-turns for calculation on highways and motorways.
", "RouteMatrixAllowOptions$Hot": "Allow Hot (High Occupancy Toll) lanes while calculating the route.
Default value: false
Allow Hov (High Occupancy vehicle) lanes while calculating the route.
Default value: false
Avoid car-shuttle-trains while calculating the route.
", "RouteMatrixAvoidanceOptions$ControlledAccessHighways": "Avoid controlled access highways while calculating the route.
", "RouteMatrixAvoidanceOptions$DirtRoads": "Avoid dirt roads while calculating the route.
", "RouteMatrixAvoidanceOptions$Ferries": "Avoid ferries while calculating the route.
", "RouteMatrixAvoidanceOptions$TollRoads": "Avoids roads where the specified toll transponders are the only mode of payment.
", "RouteMatrixAvoidanceOptions$TollTransponders": "Avoids roads where the specified toll transponders are the only mode of payment.
", "RouteMatrixAvoidanceOptions$Tunnels": "Avoid tunnels while calculating the route.
", "RouteMatrixAvoidanceOptions$UTurns": "Avoid U-turns for calculation on highways and motorways.
", "RouteMatrixBoundary$Unbounded": "No restrictions in terms of a routing boundary, and is typically used for longer routes.
", "RouteOriginOptions$AvoidUTurns": "Avoid U-turns for calculation on highways and motorways.
", "RouteSpanSpeedLimitDetails$Unlimited": "If the span doesn't have a speed limit like the Autobahn.
", "RouteTollOptions$AllTransponders": "Specifies if the user has valid transponder with access to all toll systems. This impacts toll calculation, and if true the price with transponders is used.
", "RouteTollOptions$AllVignettes": "Specifies if the user has valid vignettes with access for all toll roads. If a user has a vignette for a toll road, then toll cost for that road is omitted since no further payment is necessary.
", "RouteTollPass$IncludesReturnTrip": "If the pass includes the rate for the return leg of the trip.
", "RouteTollPass$SeniorPass": "If the pass is only valid for senior persons.
", "RouteTollPrice$Estimate": "If the price is an estimate or an exact value.
", "RouteTollPrice$Range": "If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.
", "RouteTollPriceSummary$Estimate": "If the price is an estimate or an exact value.
", "RouteTollPriceSummary$Range": "If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.
", "RouteViolatedConstraints$AllHazardsRestricted": "This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.
", "RouteViolatedConstraints$TimeDependent": "The time dependent constraint.
", "RouteViolatedConstraints$TravelMode": "Travel mode corresponding to the leg.
", "RouteWaypoint$AvoidUTurns": " Avoid U-turns for calculation on highways and motorways. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Avoidance options for cars-shuttles-trains.
", "WaypointOptimizationAvoidanceOptions$ControlledAccessHighways": "Avoid controlled access highways while calculating the route.
", "WaypointOptimizationAvoidanceOptions$DirtRoads": "Avoid dirt roads while calculating the route.
", "WaypointOptimizationAvoidanceOptions$Ferries": "Avoidance options for ferries.
", "WaypointOptimizationAvoidanceOptions$TollRoads": "Avoids roads where the specified toll transponders are the only mode of payment.
", "WaypointOptimizationAvoidanceOptions$Tunnels": "Avoid tunnels while calculating the route.
", "WaypointOptimizationAvoidanceOptions$UTurns": "Avoid U-turns for calculation on highways and motorways.
" } }, "SensitiveDouble": { "base": null, "refs": { "Circle$Radius": "Radius of the Circle.
Unit: meters
The expected street name near the point. Helps disambiguate matching when multiple roads are within range.
", "LocalizedString$Value": "The value of the localized string.
", "RoadSnapNotice$Title": "The notice title.
", "RouteEmissionType$Co2EmissionClass": "The CO 2 emission classes.
", "RouteEmissionType$Type": "Type of the emission.
Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev
Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Route name of the ferry line.
", "RouteFerryPlace$Name": "The name of the place.
", "RouteFerryTravelStep$Instruction": "Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Attempts to match the provided position to a road similar to the provided name.
", "RouteNumber$Value": "The route number.
", "RoutePedestrianPlace$Name": "The name of the place.
", "RoutePedestrianTravelStep$Instruction": "Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Time when the rate is valid.
", "RouteTollRate$Id": "The Toll rate Id.
", "RouteTollRate$Name": "The name of the toll.
", "RouteTollSystem$Name": "The toll system name.
", "RouteTransponder$SystemName": "Names of the toll system collecting the toll.
", "RouteVehicleIncident$Description": "Brief readable description of the incident.
", "RouteVehicleNoticeDetail$Title": "The notice title.
", "RouteVehiclePlace$Name": "The name of the place.
", "RouteVehicleTravelStep$Instruction": "Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
The name of the zone.
", "WaypointOptimizationFailedConstraint$Reason": "Reason for the failed constraint.
" } }, "SideOfStreetMatchingStrategy": { "base": null, "refs": { "IsolineSideOfStreetOptions$UseWith": "Controls whether side-of-street matching is applied to any street (AnyStreet) or only to divided roads (DividedStreetOnly). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don't account for necessary U-turns or detours to reach the correct side.
Default value: DividedStreetOnly
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
Default value: DividedStreetOnly
Strategy that defines when the side of street position should be used.
Default value: DividedStreetOnly
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
Default value: DividedStreetOnly
The radius around the provided tracepoint that is considered for snapping.
Unit: meters
Default value: 300
List of trace points to be snapped onto the road network.
" } }, "SnapToRoadsResponse": { "base": null, "refs": {} }, "SpeedKilometersPerHour": { "base": null, "refs": { "RoadSnapTracePoint$Speed": "Speed at the specified trace point .
Unit: kilometers per hour
Estimated speed while traversing the span without traffic congestion.
Unit: kilometers per hour
Estimated speed while traversing the span under typical traffic congestion.
Unit: kilometers per hour
Maximum speed.
Unit: kilometers per hour
The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.
", "CalculateRouteMatrixResponse$PricingBucket": "The pricing bucket for which the query is charged at.
", "CalculateRoutesResponse$PricingBucket": "The pricing bucket for which the query is charged at.
", "InternalServerException$Message": null, "OptimizeWaypointsResponse$PricingBucket": "The pricing bucket for which the query is charged at.
", "RouteTollPaymentSite$Name": "Name of the payment site.
", "RouteViolatedConstraints$RestrictedTimes": "Access radius restrictions based on time.
", "RouteViolatedConstraints$TruckRoadType": "Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
The pricing bucket for which the query is charged at.
", "ThrottlingException$Message": null, "ValidationException$Message": null, "ValidationExceptionField$Name": "The name of the Validation Exception Field.
", "ValidationExceptionField$Message": "The error message.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": {} }, "TimeOfDay": { "base": null, "refs": { "WaypointOptimizationAccessHoursEntry$TimeOfDay": "Time of the day.
" } }, "TimeThresholdList": { "base": null, "refs": { "IsolineThresholds$Time": "List of travel times in seconds. For example, [300, 600, 900] would calculate areas reachable within 5, 10, and 15 minutes.
" } }, "TimeThresholdListMemberLong": { "base": null, "refs": { "TimeThresholdList$member": null } }, "TimestampWithTimezoneOffset": { "base": null, "refs": { "CalculateIsolinesRequest$ArrivalTime": "Determine areas from which Destination can be reached by this time, taking into account predicted traffic conditions and working backward to account for congestion patterns. This attribute cannot be used together with DepartureTime or DepartNow. Specified as an ISO-8601 timestamp with timezone offset.
Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Determine areas that can be reached when departing at this time, taking into account predicted traffic conditions. This attribute cannot be used together with ArrivalTime or DepartNow. Specified as an ISO-8601 timestamp with timezone offset.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the Destination and ArrivalTime attributes were provided in the request.
Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Time of departure from the origin, used for traffic calculations. This attribute is returned when Origin was provided in the request and either a specific departure time was requested (DepartureTime) or DepartNow was set to true.
Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Time of departure from the origin.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Time of arrival at the destination. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Time of departure from the origin.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Departure time from the waypoint.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Timestamp of the event.
", "RouteFerryArrival$Time": "The time.
", "RouteFerryDeparture$Time": "The time.
", "RoutePedestrianArrival$Time": "The time.
", "RoutePedestrianDeparture$Time": "The time.
", "RouteVehicleArrival$Time": "The time.
", "RouteVehicleDeparture$Time": "The departure time.
", "RouteVehicleIncident$EndTime": "End timestamp of the incident.
", "RouteVehicleIncident$StartTime": "Start time of the incident.
", "WaypointOptimizationDestinationOptions$AppointmentTime": "Appointment time at the destination.
", "WaypointOptimizationOptimizedWaypoint$ArrivalTime": "Estimated time of arrival at the destination.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Estimated time of departure from the origin.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Appointment time at the waypoint.
" } }, "TrafficUsage": { "base": null, "refs": { "IsolineTrafficOptions$Usage": "Controls whether traffic data is used in calculations. UseTrafficData considers both real-time congestion and historical patterns, while IgnoreTrafficData calculates routes based solely on road types and speed limits. Using traffic data provides more accurate real-world estimates but may produce different results at different times of day.
Default value: UseTrafficData
Determines if traffic should be used or ignored while calculating the route.
Default value: UseTrafficData
Specifies how traffic data should be used when calculating routes.
Default Value: UseTrafficData
Traffic data usage depends on the time parameters in your route request:
When Usage is set to UseTrafficData:
If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).
If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.
When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.
Determines if traffic should be used or ignored while calculating the route.
Default value: UseTrafficData
For truck travel modes, indicates specific road classification types in Sweden ( BK1 through BK4) and Mexico (A2, A4, B2, B4, C, D, ET2, ET4) to avoid where possible. These road types may still be used if no reasonable alternative exists.
There are currently no other supported values as of 26th April 2024.
Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
There are currently no other supported values as of 26th April 2024.
Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
There are currently no other supported values as of 26th April 2024.
The tunnel restriction code.
Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.
Tunnel Category B
Risk Level: Limited risk
Restrictions: Few restrictions
Tunnel Category C
Risk Level: Medium risk
Restrictions: Some restrictions
Tunnel Category D
Risk Level: High risk
Restrictions: Many restrictions occur
Tunnel Category E
Risk Level: Very high risk
Restrictions: Restricted tunnel
The tunnel restriction code.
Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.
Tunnel Category B
Risk Level: Limited risk
Restrictions: Few restrictions
Tunnel Category C
Risk Level: Medium risk
Restrictions: Some restrictions
Tunnel Category D
Risk Level: High risk
Restrictions: Many restrictions occur
Tunnel Category E
Risk Level: Very high risk
Restrictions: Restricted tunnel
The tunnel restriction code.
Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.
Tunnel Category B
Risk Level: Limited risk
Restrictions: Few restrictions
Tunnel Category C
Risk Level: Medium risk
Restrictions: Some restrictions
Tunnel Category D
Risk Level: High risk
Restrictions: Many restrictions occur
Tunnel Category E
Risk Level: Very high risk
Restrictions: Restricted tunnel
The tunnel restriction code.
Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.
Tunnel Category B
Risk Level: Limited risk
Restrictions: Few restrictions
Tunnel Category C
Risk Level: Medium risk
Restrictions: Some restrictions
Tunnel Category D
Risk Level: High risk
Restrictions: Many restrictions occur
Tunnel Category E
Risk Level: Very high risk
Restrictions: Restricted tunnel
The tunnel restriction code.
Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.
Tunnel Category B
Risk Level: Limited risk
Restrictions: Few restrictions
Tunnel Category C
Risk Level: Medium risk
Restrictions: Some restrictions
Tunnel Category D
Risk Level: High risk
Restrictions: Many restrictions occur
Tunnel Category E
Risk Level: Very high risk
Restrictions: Restricted tunnel
Angle of the turn.
", "RouteEnterHighwayStepDetails$TurnAngle": "Angle of the turn.
", "RouteExitStepDetails$TurnAngle": "Angle of the turn.
", "RouteKeepStepDetails$TurnAngle": "Angle of the turn.
", "RouteRampStepDetails$TurnAngle": "Angle of the turn.
", "RouteRoundaboutEnterStepDetails$TurnAngle": "Angle of the turn.
", "RouteRoundaboutPassStepDetails$TurnAngle": "Angle of the turn.
", "RouteTurnStepDetails$TurnAngle": "Angle of the turn.
", "RouteUTurnStepDetails$TurnAngle": "Angle of the turn.
" } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an AWS service.
", "refs": {} }, "ValidationExceptionField": { "base": "The input fails to satisfy the constraints specified by the Amazon Location service.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$FieldList": "The field where the invalid entry was detected.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$Reason": "A message with the reason for the validation exception error.
" } }, "WaypointId": { "base": null, "refs": { "WaypointOptimizationConnection$From": "contains the ID of the starting waypoint in this connection.
", "WaypointOptimizationConnection$To": "Contains the ID of the ending waypoint in this connection.
", "WaypointOptimizationDestinationOptions$Id": "The waypoint Id.
", "WaypointOptimizationImpedingWaypoint$Id": "The waypoint Id.
", "WaypointOptimizationOptimizedWaypoint$Id": "The waypoint Id.
", "WaypointOptimizationOriginOptions$Id": "The Origin Id.
", "WaypointOptimizationWaypoint$Id": "The waypoint Id.
" } }, "WaypointIndex": { "base": null, "refs": { "BeforeWaypointsList$member": null } }, "WaypointOptimizationAccessHours": { "base": "Access hours corresponding to when a destination can be visited.
", "refs": { "WaypointOptimizationDestinationOptions$AccessHours": "Access hours corresponding to when a waypoint can be visited.
", "WaypointOptimizationWaypoint$AccessHours": "Access hours corresponding to when a waypoint can be visited.
" } }, "WaypointOptimizationAccessHoursEntry": { "base": "Hours of entry.
", "refs": { "WaypointOptimizationAccessHours$From": "Contains the ID of the starting waypoint in this connection.
", "WaypointOptimizationAccessHours$To": "Contains the ID of the ending waypoint in this connection.
" } }, "WaypointOptimizationAvoidanceArea": { "base": "The area to be avoided.
", "refs": { "WaypointOptimizationAvoidanceOptionsAreasList$member": null } }, "WaypointOptimizationAvoidanceAreaGeometry": { "base": "Geometry of the area to be avoided.
", "refs": { "WaypointOptimizationAvoidanceArea$Geometry": "Geometry of the area to be avoided.
" } }, "WaypointOptimizationAvoidanceOptions": { "base": "Specifies options for areas to avoid. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.
", "refs": { "OptimizeWaypointsRequest$Avoid": "Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.
" } }, "WaypointOptimizationAvoidanceOptionsAreasList": { "base": null, "refs": { "WaypointOptimizationAvoidanceOptions$Areas": "Areas to be avoided.
" } }, "WaypointOptimizationClusteringAlgorithm": { "base": null, "refs": { "WaypointOptimizationClusteringOptions$Algorithm": "The algorithm to be used. DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster. TopologySegment assigns all the waypoints that are within the same topology segment into a single cluster. A Topology segment is a linear stretch of road between two junctions.
Options for WaypointOptimizationClustering.
", "refs": { "OptimizeWaypointsRequest$Clustering": "Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.
" } }, "WaypointOptimizationConnection": { "base": "This contains information such as distance and duration from one waypoint to the next waypoint in the sequence.
", "refs": { "WaypointOptimizationConnectionList$member": null } }, "WaypointOptimizationConnectionList": { "base": null, "refs": { "OptimizeWaypointsResponse$Connections": "Details about the connection from one waypoint to the next, within the optimized sequence.
" } }, "WaypointOptimizationConstraint": { "base": null, "refs": { "WaypointOptimizationFailedConstraint$Constraint": "The failed constraint.
" } }, "WaypointOptimizationDestinationOptions": { "base": "Destination related options.
", "refs": { "OptimizeWaypointsRequest$DestinationOptions": "Destination related options.
" } }, "WaypointOptimizationDriverOptions": { "base": "Driver related options.
", "refs": { "OptimizeWaypointsRequest$Driver": "Driver related options.
" } }, "WaypointOptimizationDrivingDistanceOptions": { "base": "Driving distance related options.
", "refs": { "WaypointOptimizationClusteringOptions$DrivingDistanceOptions": "Driving distance options to be used when the clustering algorithm is DrivingDistance.
" } }, "WaypointOptimizationExclusionOptions": { "base": "Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.
", "refs": { "OptimizeWaypointsRequest$Exclude": "Features to be strictly excluded while calculating the route.
" } }, "WaypointOptimizationFailedConstraint": { "base": "The failed constraint.
", "refs": { "WaypointOptimizationFailedConstraintList$member": null } }, "WaypointOptimizationFailedConstraintList": { "base": null, "refs": { "WaypointOptimizationImpedingWaypoint$FailedConstraints": "Failed constraints for an impeding waypoint.
" } }, "WaypointOptimizationHazardousCargoType": { "base": null, "refs": { "WaypointOptimizationHazardousCargoTypeList$member": null } }, "WaypointOptimizationHazardousCargoTypeList": { "base": null, "refs": { "WaypointOptimizationTruckOptions$HazardousCargos": "List of Hazardous cargo contained in the vehicle.
" } }, "WaypointOptimizationImpedingWaypoint": { "base": "The impeding waypoint.
", "refs": { "WaypointOptimizationImpedingWaypointList$member": null } }, "WaypointOptimizationImpedingWaypointList": { "base": null, "refs": { "OptimizeWaypointsResponse$ImpedingWaypoints": "Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.
" } }, "WaypointOptimizationOptimizedWaypoint": { "base": "The optimized waypoint.
", "refs": { "WaypointOptimizationOptimizedWaypointList$member": null } }, "WaypointOptimizationOptimizedWaypointList": { "base": null, "refs": { "OptimizeWaypointsResponse$OptimizedWaypoints": "Waypoints in the order of the optimized sequence.
" } }, "WaypointOptimizationOriginOptions": { "base": "Origin related options.
", "refs": { "OptimizeWaypointsRequest$OriginOptions": "Origin related options.
" } }, "WaypointOptimizationPedestrianOptions": { "base": "Options related to a pedestrian.
", "refs": { "WaypointOptimizationTravelModeOptions$Pedestrian": "Travel mode options when the provided travel mode is Pedestrian.
Walking speed.
Unit: kilometers per hour
Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.
Unit: seconds
Long cycle for a driver work-rest schedule.
", "WaypointOptimizationRestCycles$ShortCycle": "Short cycle for a driver work-rest schedule
" } }, "WaypointOptimizationRestCycles": { "base": "Resting phase of the cycle.
", "refs": { "WaypointOptimizationDriverOptions$RestCycles": "Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.
" } }, "WaypointOptimizationRestProfile": { "base": "Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.
", "refs": { "WaypointOptimizationDriverOptions$RestProfile": "Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.
" } }, "WaypointOptimizationRestProfileProfileString": { "base": null, "refs": { "WaypointOptimizationRestProfile$Profile": "Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.
" } }, "WaypointOptimizationSequencingObjective": { "base": null, "refs": { "OptimizeWaypointsRequest$OptimizeSequencingFor": "Specifies the optimization criteria for the calculated sequence.
Default value: FastestRoute.
If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.
" } }, "WaypointOptimizationSideOfStreetOptions": { "base": "Options to configure matching the provided position to a side of the street.
", "refs": { "WaypointOptimizationDestinationOptions$SideOfStreet": "Options to configure matching the provided position to a side of the street.
", "WaypointOptimizationWaypoint$SideOfStreet": "Options to configure matching the provided position to a side of the street.
" } }, "WaypointOptimizationTimeBreakdown": { "base": "Time breakdown for the sequence.
", "refs": { "OptimizeWaypointsResponse$TimeBreakdown": "Time breakdown for the sequence.
" } }, "WaypointOptimizationTrafficOptions": { "base": "Options related to traffic.
", "refs": { "OptimizeWaypointsRequest$Traffic": "Traffic-related options.
" } }, "WaypointOptimizationTrailerOptions": { "base": "Trailer options corresponding to the vehicle.
", "refs": { "WaypointOptimizationTruckOptions$Trailer": "Trailer options corresponding to the vehicle.
" } }, "WaypointOptimizationTrailerOptionsTrailerCountInteger": { "base": null, "refs": { "WaypointOptimizationTrailerOptions$TrailerCount": "Number of trailers attached to the vehicle.
Default value: 0
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default value: Car
Travel mode related options for the provided travel mode.
", "refs": { "OptimizeWaypointsRequest$TravelModeOptions": "Travel mode related options for the provided travel mode.
" } }, "WaypointOptimizationTruckOptions": { "base": "Travel mode options when the provided travel mode is Truck.
Travel mode options when the provided travel mode is Truck.
Height of the vehicle.
Unit: centimeters
Length of the vehicle.
Unit: centimeters
Width of the vehicle.
Unit: centimeters
The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
Waypoint between the Origin and Destination.
", "refs": { "WaypointOptimizationWaypointList$member": null } }, "WaypointOptimizationWaypointList": { "base": null, "refs": { "OptimizeWaypointsRequest$Waypoints": "List of waypoints between the Origin and Destination.
The gross vehicle weight (the maximum weight a vehicle can safely operate at, as specified by the manufacturer) in kilograms. Used to avoid roads with weight restrictions and ensure compliance with maximum allowed vehicle weight regulations.
Unit: kilograms
The maximum cargo weight in kilograms that the vehicle (including attached trailers) is rated to carry.
Unit: kilograms
The heaviest weight per axle in kilograms, regardless of axle type or grouping. Used for roads with axle-weight restrictions in regions where regulations don't distinguish between different axle configurations.
Unit: kilograms
Gross weight of the vehicle including trailers, and goods at capacity.
Unit: kilograms
Gross weight of the vehicle including trailers, and goods at capacity.
Unit: kilograms
Payload capacity of the vehicle and trailers attached.
Unit: kilograms
Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.
Unit: kilograms
Gross weight of the vehicle including trailers, and goods at capacity.
Unit: kilograms
Payload capacity of the vehicle and trailers attached.
Unit: kilograms
Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.
Unit: kilograms
The maximum load capacity of the vehicle.
Unit: kilograms
The maximum weight per axle of the vehicle.
Unit: kilograms
The constraint value.
Unit: kilograms
Gross weight of the vehicle including trailers, and goods at capacity.
Unit: kilograms
Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.
Unit: kilograms
Total weight in kilograms for single axle configurations.
Unit: kilograms
Total weight in kilograms for tandem (two adjacent) axle configurations.
Unit: kilograms
Total weight in kilograms for triple (three adjacent) axle configurations.
Unit: kilograms
Total weight in kilograms for quad (four adjacent) axle configurations.
Unit: kilograms
Total weight in kilograms for quint (five adjacent) axle configurations.
Unit: kilograms
Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.
Unit: kilograms
Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.
Unit: kilograms
Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.
", "RouteTruckOptions$WeightPerAxleGroup": "Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.
Unit: kilograms
The maximum weight per axle group of the vehicle.
Unit: kilograms