Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.
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.
CalculateRoutes computes routes given the following required parameters: Origin and Destination.
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.
SnapToRoads matches GPS trace to roads most likely traveled on.
You don't have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ApiKey":{ "type":"string", "max":1000, "min":0, "sensitive":true }, "BeforeWaypointsList":{ "type":"list", "member":{"shape":"WaypointIndex"} }, "BoundingBox":{ "type":"list", "member":{"shape":"Double"}, "max":4, "min":4, "sensitive":true }, "CalculateIsolinesRequest":{ "type":"structure", "required":["Thresholds"], "members":{ "Allow":{ "shape":"IsolineAllowOptions", "documentation":"Features that are allowed while calculating an isoline.
" }, "ArrivalTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"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
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.
" }, "DepartNow":{ "shape":"SensitiveBoolean", "documentation":"Uses the current time as the time of departure.
" }, "DepartureTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"Time of departure from thr 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
The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
Destination related options.
" }, "IsolineGeometryFormat":{ "shape":"GeometryFormat", "documentation":"The format of the returned IsolineGeometry.
Default Value:FlexiblePolyline
Defines the granularity of the returned Isoline.
" }, "Key":{ "shape":"ApiKey", "documentation":"Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" }, "OptimizeIsolineFor":{ "shape":"IsolineOptimizationObjective", "documentation":"Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.
Default Value: BalancedCalculation
Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
The start position for the route.
" }, "OriginOptions":{ "shape":"IsolineOriginOptions", "documentation":"Origin related options.
" }, "Thresholds":{ "shape":"IsolineThresholds", "documentation":"Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.
You incur a calculation charge for each threshold. Using a large amount of thresholds in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.
" }, "Traffic":{ "shape":"IsolineTrafficOptions", "documentation":"Traffic related options.
" }, "TravelMode":{ "shape":"IsolineTravelMode", "documentation":"Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The mode Scooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.
Default Value: Car
Travel mode related options for the provided travel mode.
" } } }, "CalculateIsolinesResponse":{ "type":"structure", "required":[ "IsolineGeometryFormat", "Isolines", "PricingBucket" ], "members":{ "ArrivalTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"Time of arrival at the destination. This parameter is returned only if the Destination parameters was 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 thr 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
The format of the returned IsolineGeometry.
Default Value:FlexiblePolyline
Calculated isolines and associated properties.
" }, "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "SnappedDestination":{ "shape":"Position", "documentation":"Snapped destination that was used for the Isoline calculation.
" }, "SnappedOrigin":{ "shape":"Position", "documentation":"Snapped origin that was used for the Isoline calculation.
" } } }, "CalculateRouteMatrixRequest":{ "type":"structure", "required":[ "Destinations", "Origins", "RoutingBoundary" ], "members":{ "Allow":{ "shape":"RouteMatrixAllowOptions", "documentation":"Features that are allowed while calculating a route.
" }, "Avoid":{ "shape":"RouteMatrixAvoidanceOptions", "documentation":"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.
" }, "DepartNow":{ "shape":"SensitiveBoolean", "documentation":"Uses the current time as the time of departure.
" }, "DepartureTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"Time of departure from thr 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
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. See Amazon Location's pricing page for more information.
Features to be strictly excluded while calculating the route.
" }, "Key":{ "shape":"ApiKey", "documentation":"Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" }, "OptimizeRoutingFor":{ "shape":"RoutingObjective", "documentation":"Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
The position in longitude and latitude for the origin.
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. See Amazon Location's pricing page for more information.
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.
Traffic related options.
" }, "TravelMode":{ "shape":"RouteMatrixTravelMode", "documentation":"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.
" } } }, "CalculateRouteMatrixRequestDestinationsList":{ "type":"list", "member":{"shape":"RouteMatrixDestination"}, "min":1 }, "CalculateRouteMatrixRequestOriginsList":{ "type":"list", "member":{"shape":"RouteMatrixOrigin"}, "min":1 }, "CalculateRouteMatrixResponse":{ "type":"structure", "required":[ "ErrorCount", "PricingBucket", "RouteMatrix", "RoutingBoundary" ], "members":{ "ErrorCount":{ "shape":"CalculateRouteMatrixResponseErrorCountInteger", "documentation":"The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
" }, "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "RouteMatrix":{ "shape":"RouteMatrix", "documentation":"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.
" }, "RoutingBoundary":{ "shape":"RouteMatrixBoundary", "documentation":"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.
Features that are allowed while calculating a route.
" }, "ArrivalTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"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
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.
" }, "DepartNow":{ "shape":"SensitiveBoolean", "documentation":"Uses the current time as the time of departure.
" }, "DepartureTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"Time of departure from thr 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
The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
Destination related options.
" }, "Driver":{ "shape":"RouteDriverOptions", "documentation":"Driver related options.
" }, "Exclude":{ "shape":"RouteExclusionOptions", "documentation":"Features to be strictly excluded while calculating the route.
" }, "InstructionsMeasurementSystem":{ "shape":"MeasurementSystem", "documentation":"Measurement system to be used for instructions within steps in the response.
" }, "Key":{ "shape":"ApiKey", "documentation":"Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" }, "Languages":{ "shape":"CalculateRoutesRequestLanguagesList", "documentation":"List of languages for instructions within steps in the response.
Instructions in the requested language are returned only if they are available.
A list of optional additional parameters such as timezone that can be requested for each result.
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.
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 FlexiblePolyline .
Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.
Maximum number of alternative routes to be provided in the response, if available.
" }, "OptimizeRoutingFor":{ "shape":"RoutingObjective", "documentation":"Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
The start position for the route.
" }, "OriginOptions":{ "shape":"RouteOriginOptions", "documentation":"Origin related options.
" }, "SpanAdditionalFeatures":{ "shape":"RouteSpanAdditionalFeatureList", "documentation":"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.
" }, "Tolls":{ "shape":"RouteTollOptions", "documentation":"Toll related options.
" }, "Traffic":{ "shape":"RouteTrafficOptions", "documentation":"Traffic related options.
" }, "TravelMode":{ "shape":"RouteTravelMode", "documentation":"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.
" }, "TravelStepType":{ "shape":"RouteTravelStepType", "documentation":"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.
" }, "Waypoints":{ "shape":"RouteWaypointList", "documentation":"List of waypoints between the Origin and Destination.
" } } }, "CalculateRoutesRequestLanguagesList":{ "type":"list", "member":{"shape":"LanguageTag"}, "max":10, "min":0 }, "CalculateRoutesRequestMaxAlternativesInteger":{ "type":"integer", "box":true, "max":5, "min":0 }, "CalculateRoutesResponse":{ "type":"structure", "required":[ "LegGeometryFormat", "Notices", "PricingBucket", "Routes" ], "members":{ "LegGeometryFormat":{ "shape":"GeometryFormat", "documentation":"Specifies the format of the geometry returned for each leg of the route.
" }, "Notices":{ "shape":"RouteResponseNoticeList", "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "Routes":{ "shape":"RouteList", "documentation":"The path from the origin to the destination.
" } } }, "Circle":{ "type":"structure", "required":[ "Center", "Radius" ], "members":{ "Center":{ "shape":"Position", "documentation":"Center of the Circle defined in longitude and latitude coordinates.
Example: [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
Radius of the Circle.
Unit: meters
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.
An ordered list of positions used to plot a route on a map.
LineString and Polyline are mutually exclusive properties.
Radius that defines the width of the corridor.
" } }, "documentation":"Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
", "sensitive":true }, "CountryCode":{ "type":"string", "max":3, "min":2, "pattern":"([A-Z]{2}|[A-Z]{3})", "sensitive":true }, "CountryCode3":{ "type":"string", "max":3, "min":3, "pattern":"[A-Z]{3}", "sensitive":true }, "CountryCodeList":{ "type":"list", "member":{"shape":"CountryCode"}, "max":100, "min":1 }, "CurrencyCode":{ "type":"string", "max":3, "min":3, "pattern":"[A-Z]{3}" }, "DayOfWeek":{ "type":"string", "enum":[ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "sensitive":true }, "DimensionCentimeters":{ "type":"long", "max":4294967295, "min":0, "sensitive":true }, "DistanceMeters":{ "type":"long", "max":4294967295, "min":0, "sensitive":true }, "DistanceThresholdList":{ "type":"list", "member":{"shape":"DistanceThresholdListMemberLong"}, "max":5, "min":1 }, "DistanceThresholdListMemberLong":{ "type":"long", "max":300000, "min":0, "sensitive":true }, "Double":{ "type":"double", "box":true }, "DurationSeconds":{ "type":"long", "max":4294967295, "min":0, "sensitive":true }, "GeometryFormat":{ "type":"string", "enum":[ "FlexiblePolyline", "Simple" ] }, "Heading":{ "type":"double", "max":360.0, "min":0.0, "sensitive":true }, "IndexList":{ "type":"list", "member":{"shape":"Integer"} }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"The request processing has failed because of an unknown error, exception or failure.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "Isoline":{ "type":"structure", "required":[ "Connections", "Geometries" ], "members":{ "Connections":{ "shape":"IsolineConnectionList", "documentation":"Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.
" }, "DistanceThreshold":{ "shape":"DistanceMeters", "documentation":"Distance threshold corresponding to the calculated Isoline.
" }, "Geometries":{ "shape":"IsolineShapeGeometryList", "documentation":"Geometries for the Calculated isolines.
" }, "TimeThreshold":{ "shape":"DurationSeconds", "documentation":"Time threshold corresponding to the calculated isoline.
" } }, "documentation":"Calculated isolines and associated properties.
" }, "IsolineAllowOptions":{ "type":"structure", "members":{ "Hot":{ "shape":"SensitiveBoolean", "documentation":"Allow Hot (High Occupancy Toll) lanes while calculating an isoline.
Default value: false
Allow Hov (High Occupancy vehicle) lanes while calculating an isoline.
Default value: false
Features that are allowed while calculating an isoline.
" }, "IsolineAvoidanceArea":{ "type":"structure", "required":["Geometry"], "members":{ "Except":{ "shape":"IsolineAvoidanceAreaGeometryList", "documentation":"Exceptions to the provided avoidance geometry, to be included while calculating an isoline.
" }, "Geometry":{ "shape":"IsolineAvoidanceAreaGeometry", "documentation":"Geometry of the area to be avoided.
" } }, "documentation":"The area to be avoided.
" }, "IsolineAvoidanceAreaGeometry":{ "type":"structure", "members":{ "BoundingBox":{ "shape":"BoundingBox", "documentation":"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.
" }, "Corridor":{ "shape":"Corridor", "documentation":"Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
" }, "Polygon":{ "shape":"IsolineAvoidanceAreaGeometryPolygonList", "documentation":"A list of Polygon will be excluded for calculating isolines, the list can only contain 1 polygon.
" }, "PolylineCorridor":{ "shape":"PolylineCorridor", "documentation":"Geometry defined as an encoded corridor – a polyline with a radius that defines the width of the corridor. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
" }, "PolylinePolygon":{ "shape":"IsolineAvoidanceAreaGeometryPolylinePolygonList", "documentation":"A list of PolylinePolygon's that are excluded for calculating isolines, the list can only contain 1 polygon. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
" } }, "documentation":"The avoidance geometry, to be included while calculating an isoline.
" }, "IsolineAvoidanceAreaGeometryList":{ "type":"list", "member":{"shape":"IsolineAvoidanceAreaGeometry"} }, "IsolineAvoidanceAreaGeometryPolygonList":{ "type":"list", "member":{"shape":"LinearRing"}, "max":1, "min":1 }, "IsolineAvoidanceAreaGeometryPolylinePolygonList":{ "type":"list", "member":{"shape":"PolylineRing"}, "max":1, "min":1 }, "IsolineAvoidanceAreaList":{ "type":"list", "member":{"shape":"IsolineAvoidanceArea"} }, "IsolineAvoidanceOptions":{ "type":"structure", "members":{ "Areas":{ "shape":"IsolineAvoidanceAreaList", "documentation":"Areas to be avoided.
" }, "CarShuttleTrains":{ "shape":"SensitiveBoolean", "documentation":"Avoid car-shuttle-trains while calculating an isoline.
" }, "ControlledAccessHighways":{ "shape":"SensitiveBoolean", "documentation":"Avoid controlled access highways while calculating an isoline.
" }, "DirtRoads":{ "shape":"SensitiveBoolean", "documentation":"Avoid dirt roads while calculating an isoline.
" }, "Ferries":{ "shape":"SensitiveBoolean", "documentation":"Avoid ferries while calculating an isoline.
" }, "SeasonalClosure":{ "shape":"SensitiveBoolean", "documentation":"Avoid roads that have seasonal closure while calculating an isoline.
" }, "TollRoads":{ "shape":"SensitiveBoolean", "documentation":"Avoids roads where the specified toll transponders are the only mode of payment.
" }, "TollTransponders":{ "shape":"SensitiveBoolean", "documentation":"Avoids roads where the specified toll transponders are the only mode of payment.
" }, "TruckRoadTypes":{ "shape":"TruckRoadTypeList", "documentation":"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.
Avoid tunnels while calculating an isoline.
" }, "UTurns":{ "shape":"SensitiveBoolean", "documentation":"Avoid U-turns for calculation on highways and motorways.
" }, "ZoneCategories":{ "shape":"IsolineAvoidanceZoneCategoryList", "documentation":"Zone categories to be avoided.
" } }, "documentation":"Features that are avoided while calculating isolines. 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.
" }, "IsolineAvoidanceZoneCategory":{ "type":"structure", "members":{ "Category":{ "shape":"IsolineZoneCategory", "documentation":"Zone category to be avoided.
" } }, "documentation":"Zone category to be avoided.
" }, "IsolineAvoidanceZoneCategoryList":{ "type":"list", "member":{"shape":"IsolineAvoidanceZoneCategory"}, "max":3, "min":0 }, "IsolineCarOptions":{ "type":"structure", "members":{ "EngineType":{ "shape":"IsolineEngineType", "documentation":"Engine type of the vehicle.
" }, "LicensePlate":{ "shape":"IsolineVehicleLicensePlate", "documentation":"The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"IsolineCarOptionsMaxSpeedDouble", "documentation":"Maximum speed.
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Travel mode options when the provided travel mode is Car.
Index of the polygon corresponding to the \"from\" component of the connection. The polygon is available from Isoline[].Geometries.
The isoline geometry.
" }, "ToPolygonIndex":{ "shape":"IsolineConnectionToPolygonIndexInteger", "documentation":"Index of the polygon corresponding to the \"to\" component of the connection. The polygon is available from Isoline[].Geometries.
Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.
" }, "IsolineConnectionFromPolygonIndexInteger":{ "type":"integer", "box":true, "min":0 }, "IsolineConnectionGeometry":{ "type":"structure", "members":{ "LineString":{ "shape":"LineString", "documentation":"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 in a lossy compression format.
LineString and Polyline are mutually exclusive properties.
Geometry of the connection between different isoline components.
" }, "IsolineConnectionList":{ "type":"list", "member":{"shape":"IsolineConnection"} }, "IsolineConnectionToPolygonIndexInteger":{ "type":"integer", "box":true, "min":0 }, "IsolineDestinationOptions":{ "type":"structure", "members":{ "AvoidActionsForDistance":{ "shape":"DistanceMeters", "documentation":"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.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Matching":{ "shape":"IsolineMatchingOptions", "documentation":"Options to configure matching the provided position to the road network.
" }, "SideOfStreet":{ "shape":"IsolineSideOfStreetOptions", "documentation":"Options to configure matching the provided position to a side of the street.
" } }, "documentation":"Destination related options.
" }, "IsolineEngineType":{ "type":"string", "enum":[ "Electric", "InternalCombustion", "PluginHybrid" ], "sensitive":true }, "IsolineGranularityOptions":{ "type":"structure", "members":{ "MaxPoints":{ "shape":"IsolineGranularityOptionsMaxPointsInteger", "documentation":"Maximum number of points of returned Isoline.
" }, "MaxResolution":{ "shape":"DistanceMeters", "documentation":"Maximum resolution of the returned isoline.
Unit: meters
Isoline granularity related options.
" }, "IsolineGranularityOptionsMaxPointsInteger":{ "type":"integer", "box":true, "min":31 }, "IsolineHazardousCargoType":{ "type":"string", "enum":[ "Combustible", "Corrosive", "Explosive", "Flammable", "Gas", "HarmfulToWater", "Organic", "Other", "Poison", "PoisonousInhalation", "Radioactive" ], "sensitive":true }, "IsolineHazardousCargoTypeList":{ "type":"list", "member":{"shape":"IsolineHazardousCargoType"}, "max":11, "min":0 }, "IsolineList":{ "type":"list", "member":{"shape":"Isoline"}, "max":5, "min":1 }, "IsolineMatchingOptions":{ "type":"structure", "members":{ "NameHint":{ "shape":"SensitiveString", "documentation":"Attempts to match the provided position to a road similar to the provided name.
" }, "OnRoadThreshold":{ "shape":"DistanceMeters", "documentation":"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
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
" } }, "documentation":"Isoline matching related options.
" }, "IsolineOptimizationObjective":{ "type":"string", "enum":[ "AccurateCalculation", "BalancedCalculation", "FastCalculation" ] }, "IsolineOriginOptions":{ "type":"structure", "members":{ "AvoidActionsForDistance":{ "shape":"DistanceMeters", "documentation":"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.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Matching":{ "shape":"IsolineMatchingOptions", "documentation":"Options to configure matching the provided position to the road network.
" }, "SideOfStreet":{ "shape":"IsolineSideOfStreetOptions", "documentation":"Options to configure matching the provided position to a side of the street.
" } }, "documentation":"Origin related options.
" }, "IsolineScooterOptions":{ "type":"structure", "members":{ "EngineType":{ "shape":"IsolineEngineType", "documentation":"Engine type of the vehicle.
" }, "LicensePlate":{ "shape":"IsolineVehicleLicensePlate", "documentation":"The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"IsolineScooterOptionsMaxSpeedDouble", "documentation":"Maximum speed specified.
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Travel mode options when the provided travel mode is Scooter
A list of Isoline Polygons, for each isoline polygon, it contains polygons of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings).
" }, "PolylinePolygon":{ "shape":"PolylineRingList", "documentation":"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/heremaps/flexiblepolyline/blob/master/README.md.
" } }, "documentation":"Geometry of the connection between different Isoline components.
" }, "IsolineShapeGeometryList":{ "type":"list", "member":{"shape":"IsolineShapeGeometry"} }, "IsolineSideOfStreetOptions":{ "type":"structure", "required":["Position"], "members":{ "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
Default Value: DividedStreetOnly
Options to configure matching the provided position to a side of the street.
" }, "IsolineThresholds":{ "type":"structure", "members":{ "Distance":{ "shape":"DistanceThresholdList", "documentation":"Distance to be used for the isoline calculation.
" }, "Time":{ "shape":"TimeThresholdList", "documentation":"Time to be used for the isoline calculation.
" } }, "documentation":"Threshold to be used for the isoline calculation. Up to 5 thresholds per provided type can be requested.
" }, "IsolineTrafficOptions":{ "type":"structure", "members":{ "FlowEventThresholdOverride":{ "shape":"DurationSeconds", "documentation":"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.
Unit: seconds
Determines if traffic should be used or ignored while calculating the route.
Default Value: UseTrafficData
Options related to traffic.
" }, "IsolineTrailerOptions":{ "type":"structure", "members":{ "AxleCount":{ "shape":"IsolineTrailerOptionsAxleCountInteger", "documentation":"Total number of axles of the vehicle.
" }, "TrailerCount":{ "shape":"IsolineTrailerOptionsTrailerCountInteger", "documentation":"Number of trailers attached to the vehicle.
Default Value: 0
Trailer options corresponding to the vehicle.
" }, "IsolineTrailerOptionsAxleCountInteger":{ "type":"integer", "box":true, "min":1, "sensitive":true }, "IsolineTrailerOptionsTrailerCountInteger":{ "type":"integer", "box":true, "max":255, "min":1, "sensitive":true }, "IsolineTravelMode":{ "type":"string", "enum":[ "Car", "Pedestrian", "Scooter", "Truck" ] }, "IsolineTravelModeOptions":{ "type":"structure", "members":{ "Car":{ "shape":"IsolineCarOptions", "documentation":"Travel mode options when the provided travel mode is \"Car\"
" }, "Scooter":{ "shape":"IsolineScooterOptions", "documentation":"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.
Travel mode options when the provided travel mode is \"Truck\"
" } }, "documentation":"Travel mode related options for the provided travel mode.
" }, "IsolineTruckOptions":{ "type":"structure", "members":{ "AxleCount":{ "shape":"IsolineTruckOptionsAxleCountInteger", "documentation":"Total number of axles of the vehicle.
" }, "EngineType":{ "shape":"IsolineEngineType", "documentation":"Engine type of the vehicle.
" }, "GrossWeight":{ "shape":"WeightKilograms", "documentation":"Gross weight of the vehicle including trailers, and goods at capacity.
Unit: Kilograms
List of Hazardous cargo contained in the vehicle.
" }, "Height":{ "shape":"IsolineTruckOptionsHeightLong", "documentation":"Height of the vehicle.
Unit: centimeters
Height of the vehicle above its first axle.
Unit: centimeters
Kingpin to rear axle length of the vehicle.
Unit: centimeters
Length of the vehicle.
Unit: centimeters
The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"IsolineTruckOptionsMaxSpeedDouble", "documentation":"Maximum speed specified.
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Payload capacity of the vehicle and trailers attached.
Unit: kilograms
Number of tires on the vehicle.
" }, "Trailer":{ "shape":"IsolineTrailerOptions", "documentation":"Trailer options corresponding to the vehicle.
" }, "TruckType":{ "shape":"IsolineTruckType", "documentation":"Type of the truck.
" }, "TunnelRestrictionCode":{ "shape":"TunnelRestrictionCode", "documentation":"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
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
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
Width of the vehicle.
Unit: centimeters
Travel mode options when the provided travel mode is \"Truck\"
" }, "IsolineTruckOptionsAxleCountInteger":{ "type":"integer", "box":true, "max":255, "min":2, "sensitive":true }, "IsolineTruckOptionsHeightAboveFirstAxleLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "IsolineTruckOptionsHeightLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "IsolineTruckOptionsLengthLong":{ "type":"long", "max":30000, "min":0, "sensitive":true }, "IsolineTruckOptionsMaxSpeedDouble":{ "type":"double", "max":252.0, "min":3.6, "sensitive":true }, "IsolineTruckOptionsOccupancyInteger":{ "type":"integer", "box":true, "min":1, "sensitive":true }, "IsolineTruckOptionsTireCountInteger":{ "type":"integer", "box":true, "max":255, "min":1, "sensitive":true }, "IsolineTruckOptionsWidthLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "IsolineTruckType":{ "type":"string", "enum":[ "LightTruck", "StraightTruck", "Tractor" ] }, "IsolineVehicleLicensePlate":{ "type":"structure", "members":{ "LastCharacter":{ "shape":"IsolineVehicleLicensePlateLastCharacterString", "documentation":"The last character of the License Plate.
" } }, "documentation":"The vehicle license plate.
", "sensitive":true }, "IsolineVehicleLicensePlateLastCharacterString":{ "type":"string", "max":1, "min":1 }, "IsolineZoneCategory":{ "type":"string", "enum":[ "CongestionPricing", "Environmental", "Vignette" ] }, "LanguageTag":{ "type":"string", "max":35, "min":2 }, "LineString":{ "type":"list", "member":{"shape":"Position"}, "min":2 }, "LinearRing":{ "type":"list", "member":{"shape":"Position"}, "min":4 }, "LinearRings":{ "type":"list", "member":{"shape":"LinearRing"}, "min":1 }, "LocalizedString":{ "type":"structure", "required":["Value"], "members":{ "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "Value":{ "shape":"SensitiveString", "documentation":"The value of the localized string.
" } }, "documentation":"The localized string.
" }, "LocalizedStringList":{ "type":"list", "member":{"shape":"LocalizedString"} }, "MatchingStrategy":{ "type":"string", "enum":[ "MatchAny", "MatchMostSignificantRoad" ] }, "MeasurementSystem":{ "type":"string", "enum":[ "Metric", "Imperial" ] }, "OptimizeWaypointsRequest":{ "type":"structure", "required":["Origin"], "members":{ "Avoid":{ "shape":"WaypointOptimizationAvoidanceOptions", "documentation":"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.
" }, "Clustering":{ "shape":"WaypointOptimizationClusteringOptions", "documentation":"Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.
" }, "DepartureTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"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
The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].
Destination related options.
" }, "Driver":{ "shape":"WaypointOptimizationDriverOptions", "documentation":"Driver related options.
" }, "Exclude":{ "shape":"WaypointOptimizationExclusionOptions", "documentation":"Features to be strictly excluded while calculating the route.
" }, "Key":{ "shape":"ApiKey", "documentation":"Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" }, "OptimizeSequencingFor":{ "shape":"WaypointOptimizationSequencingObjective", "documentation":"Specifies the optimization criteria for the calculated sequence.
Default Value: FastestRoute.
The start position for the route.
" }, "OriginOptions":{ "shape":"WaypointOptimizationOriginOptions", "documentation":"Origin related options.
" }, "Traffic":{ "shape":"WaypointOptimizationTrafficOptions", "documentation":"Traffic-related options.
" }, "TravelMode":{ "shape":"WaypointOptimizationTravelMode", "documentation":"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.
" }, "Waypoints":{ "shape":"WaypointOptimizationWaypointList", "documentation":"List of waypoints between the Origin and Destination.
Details about the connection from one waypoint to the next, within the optimized sequence.
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"Overall distance to travel the whole sequence.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"Overall duration to travel the whole sequence.
Unit: seconds
Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.
" }, "OptimizedWaypoints":{ "shape":"WaypointOptimizationOptimizedWaypointList", "documentation":"Waypoints in the order of the optimized sequence.
" }, "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "TimeBreakdown":{ "shape":"WaypointOptimizationTimeBreakdown", "documentation":"Time breakdown for the sequence.
" } } }, "Polyline":{ "type":"string", "min":1, "sensitive":true }, "PolylineCorridor":{ "type":"structure", "required":[ "Polyline", "Radius" ], "members":{ "Polyline":{ "shape":"Polyline", "documentation":"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.
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
Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
", "sensitive":true }, "PolylineRing":{ "type":"string", "min":1, "sensitive":true }, "PolylineRingList":{ "type":"list", "member":{"shape":"PolylineRing"}, "min":1 }, "Position":{ "type":"list", "member":{"shape":"Double"}, "max":2, "min":2, "sensitive":true }, "Position23":{ "type":"list", "member":{"shape":"Double"}, "max":3, "min":2, "sensitive":true }, "RoadSnapHazardousCargoType":{ "type":"string", "enum":[ "Combustible", "Corrosive", "Explosive", "Flammable", "Gas", "HarmfulToWater", "Organic", "Other", "Poison", "PoisonousInhalation", "Radioactive" ], "sensitive":true }, "RoadSnapHazardousCargoTypeList":{ "type":"list", "member":{"shape":"RoadSnapHazardousCargoType"}, "max":11, "min":0 }, "RoadSnapNotice":{ "type":"structure", "required":[ "Code", "Title", "TracePointIndexes" ], "members":{ "Code":{ "shape":"RoadSnapNoticeCode", "documentation":"Code corresponding to the issue.
" }, "Title":{ "shape":"SensitiveString", "documentation":"The notice title.
" }, "TracePointIndexes":{ "shape":"RoadSnapTracePointIndexList", "documentation":"TracePoint indices for which the provided notice code corresponds to.
" } }, "documentation":"Notices provide information around factors that may have influenced snapping in a manner atypical to the standard use cases.
" }, "RoadSnapNoticeCode":{ "type":"string", "enum":[ "TracePointsHeadingIgnored", "TracePointsIgnored", "TracePointsMovedByLargeDistance", "TracePointsNotMatched", "TracePointsOutOfSequence", "TracePointsSpeedEstimated", "TracePointsSpeedIgnored" ], "sensitive":true }, "RoadSnapNoticeList":{ "type":"list", "member":{"shape":"RoadSnapNotice"} }, "RoadSnapSnappedGeometry":{ "type":"structure", "members":{ "LineString":{ "shape":"LineString", "documentation":"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 in a lossy compression format.
LineString and Polyline are mutually exclusive properties.
Interpolated geometry for the snapped route that is overlay-able onto a map.
" }, "RoadSnapSnappedTracePoint":{ "type":"structure", "required":[ "Confidence", "OriginalPosition", "SnappedPosition" ], "members":{ "Confidence":{ "shape":"RoadSnapSnappedTracePointConfidenceDouble", "documentation":"Confidence value for the correctness of this point match.
" }, "OriginalPosition":{ "shape":"Position", "documentation":"Position of the TracePoint provided within the request, at the same index.
" }, "SnappedPosition":{ "shape":"Position", "documentation":"Snapped position of the TracePoint provided within the request, at the same index.
" } }, "documentation":"TracePoints snapped onto the road network.
" }, "RoadSnapSnappedTracePointConfidenceDouble":{ "type":"double", "box":true, "max":1, "min":0, "sensitive":true }, "RoadSnapSnappedTracePointList":{ "type":"list", "member":{"shape":"RoadSnapSnappedTracePoint"} }, "RoadSnapTracePoint":{ "type":"structure", "required":["Position"], "members":{ "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
Speed at the specified trace point .
Unit: KilometersPerHour
Timestamp of the event.
" } }, "documentation":"TracePoint indices for which the provided notice code corresponds to.
" }, "RoadSnapTracePointIndexList":{ "type":"list", "member":{"shape":"Integer"}, "max":1000, "min":1, "sensitive":true }, "RoadSnapTrailerOptions":{ "type":"structure", "members":{ "TrailerCount":{ "shape":"RoadSnapTrailerOptionsTrailerCountInteger", "documentation":"Number of trailers attached to the vehicle.
Default Value: 0
Trailer options corresponding to the vehicle.
" }, "RoadSnapTrailerOptionsTrailerCountInteger":{ "type":"integer", "box":true, "max":255, "min":0, "sensitive":true }, "RoadSnapTravelMode":{ "type":"string", "enum":[ "Car", "Pedestrian", "Scooter", "Truck" ] }, "RoadSnapTravelModeOptions":{ "type":"structure", "members":{ "Truck":{ "shape":"RoadSnapTruckOptions", "documentation":"Travel mode options when the provided travel mode is \"Truck\".
" } }, "documentation":"Travel mode related options for the provided travel mode.
" }, "RoadSnapTruckOptions":{ "type":"structure", "members":{ "GrossWeight":{ "shape":"WeightKilograms", "documentation":"Gross weight of the vehicle including trailers, and goods at capacity.
Unit: Kilograms
List of Hazardous cargos contained in the vehicle.
" }, "Height":{ "shape":"RoadSnapTruckOptionsHeightLong", "documentation":"Height of the vehicle.
Unit: centimeters
Length of the vehicle.
Unit: centimeters
Trailer options corresponding to the vehicle.
" }, "TunnelRestrictionCode":{ "shape":"TunnelRestrictionCode", "documentation":"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 in centimenters.
" } }, "documentation":"Travel mode options when the provided travel mode is \"Truck\".
" }, "RoadSnapTruckOptionsHeightLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "RoadSnapTruckOptionsLengthLong":{ "type":"long", "max":30000, "min":0, "sensitive":true }, "RoadSnapTruckOptionsWidthLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "RoundaboutAngle":{ "type":"double", "max":360, "min":-360 }, "Route":{ "type":"structure", "required":[ "Legs", "MajorRoadLabels" ], "members":{ "Legs":{ "shape":"RouteLegList", "documentation":"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.
" }, "MajorRoadLabels":{ "shape":"RouteMajorRoadLabelsList", "documentation":"Important labels including names and route numbers that differentiate the current route from the alternatives presented.
" }, "Summary":{ "shape":"RouteSummary", "documentation":"Summarized details of the leg.
" } }, "documentation":"The route.
" }, "RouteAllowOptions":{ "type":"structure", "members":{ "Hot":{ "shape":"SensitiveBoolean", "documentation":"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
Features that are allowed while calculating a route.
" }, "RouteAvoidanceArea":{ "type":"structure", "required":["Geometry"], "members":{ "Except":{ "shape":"RouteAvoidanceAreaGeometryList", "documentation":"Exceptions to the provided avoidance geometry, to be included while calculating the route.
" }, "Geometry":{"shape":"RouteAvoidanceAreaGeometry"} }, "documentation":"Areas to be avoided.
" }, "RouteAvoidanceAreaGeometry":{ "type":"structure", "members":{ "Corridor":{ "shape":"Corridor", "documentation":"Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
" }, "BoundingBox":{ "shape":"BoundingBox", "documentation":"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.
" }, "Polygon":{ "shape":"RouteAvoidanceAreaGeometryPolygonList", "documentation":"Geometry defined as a polygon with only one linear ring.
" }, "PolylineCorridor":{ "shape":"PolylineCorridor", "documentation":"Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
" }, "PolylinePolygon":{ "shape":"RouteAvoidanceAreaGeometryPolylinePolygonList", "documentation":"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/heremaps/flexiblepolyline/blob/master/README.md.
" } }, "documentation":"Geometry of the area to be avoided.
" }, "RouteAvoidanceAreaGeometryList":{ "type":"list", "member":{"shape":"RouteAvoidanceAreaGeometry"} }, "RouteAvoidanceAreaGeometryPolygonList":{ "type":"list", "member":{"shape":"LinearRing"}, "max":1, "min":1 }, "RouteAvoidanceAreaGeometryPolylinePolygonList":{ "type":"list", "member":{"shape":"PolylineRing"}, "max":1, "min":1 }, "RouteAvoidanceAreaList":{ "type":"list", "member":{"shape":"RouteAvoidanceArea"} }, "RouteAvoidanceOptions":{ "type":"structure", "members":{ "Areas":{ "shape":"RouteAvoidanceAreaList", "documentation":"Areas to be avoided.
" }, "CarShuttleTrains":{ "shape":"SensitiveBoolean", "documentation":"Avoid car-shuttle-trains while calculating the route.
" }, "ControlledAccessHighways":{ "shape":"SensitiveBoolean", "documentation":"Avoid controlled access highways while calculating the route.
" }, "DirtRoads":{ "shape":"SensitiveBoolean", "documentation":"Avoid dirt roads while calculating the route.
" }, "Ferries":{ "shape":"SensitiveBoolean", "documentation":"Avoid ferries while calculating the route.
" }, "SeasonalClosure":{ "shape":"SensitiveBoolean", "documentation":"Avoid roads that have seasonal closure while calculating the route.
" }, "TollRoads":{ "shape":"SensitiveBoolean", "documentation":"Avoids roads where the specified toll transponders are the only mode of payment.
" }, "TollTransponders":{ "shape":"SensitiveBoolean", "documentation":"Avoids roads where the specified toll transponders are the only mode of payment.
" }, "TruckRoadTypes":{ "shape":"TruckRoadTypeList", "documentation":"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.
Avoid tunnels while calculating the route.
" }, "UTurns":{ "shape":"SensitiveBoolean", "documentation":"Avoid U-turns for calculation on highways and motorways.
" }, "ZoneCategories":{ "shape":"RouteAvoidanceZoneCategoryList", "documentation":"Zone categories to be avoided.
" } }, "documentation":"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.
" }, "RouteAvoidanceZoneCategory":{ "type":"structure", "required":["Category"], "members":{ "Category":{ "shape":"RouteZoneCategory", "documentation":"Zone category to be avoided.
" } }, "documentation":"Zone categories to be avoided.
" }, "RouteAvoidanceZoneCategoryList":{ "type":"list", "member":{"shape":"RouteAvoidanceZoneCategory"}, "max":3, "min":0 }, "RouteCarOptions":{ "type":"structure", "members":{ "EngineType":{ "shape":"RouteEngineType", "documentation":"Engine type of the vehicle.
" }, "LicensePlate":{ "shape":"RouteVehicleLicensePlate", "documentation":"The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"RouteCarOptionsMaxSpeedDouble", "documentation":"Maximum speed specified.
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Travel mode options when the provided travel mode is Car.
Name of the intersection, if applicable to the step.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details related to the continue highway step.
" }, "RouteContinueStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" } }, "documentation":"Details related to the continue step.
" }, "RouteDestinationOptions":{ "type":"structure", "members":{ "AvoidActionsForDistance":{ "shape":"RouteDestinationOptionsAvoidActionsForDistanceLong", "documentation":"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.
" }, "AvoidUTurns":{ "shape":"SensitiveBoolean", "documentation":"Avoid U-turns for calculation on highways and motorways.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Matching":{ "shape":"RouteMatchingOptions", "documentation":"Options to configure matching the provided position to the road network.
" }, "SideOfStreet":{ "shape":"RouteSideOfStreetOptions", "documentation":"Options to configure matching the provided position to a side of the street.
" }, "StopDuration":{ "shape":"DurationSeconds", "documentation":"Duration of the stop.
Unit: seconds
Options related to the destination.
" }, "RouteDestinationOptionsAvoidActionsForDistanceLong":{ "type":"long", "max":2000, "sensitive":true }, "RouteDirection":{ "type":"string", "enum":[ "East", "North", "South", "West" ], "sensitive":true }, "RouteDriverOptions":{ "type":"structure", "members":{ "Schedule":{ "shape":"RouteDriverScheduleIntervalList", "documentation":"Driver work-rest schedule. Stops are added to fulfil the provided rest schedule.
" } }, "documentation":"Driver related options.
" }, "RouteDriverScheduleInterval":{ "type":"structure", "required":[ "DriveDuration", "RestDuration" ], "members":{ "DriveDuration":{ "shape":"DurationSeconds", "documentation":"Maximum allowed driving time before stopping to rest.
Unit: seconds
Resting time before the driver can continue driving.
Unit: seconds
Interval of the driver work-rest schedule. Stops are added to fulfil the provided rest schedule.
" }, "RouteDriverScheduleIntervalList":{ "type":"list", "member":{"shape":"RouteDriverScheduleInterval"} }, "RouteEmissionType":{ "type":"structure", "required":["Type"], "members":{ "Co2EmissionClass":{ "shape":"SensitiveString", "documentation":"The CO 2 emission classes.
" }, "Type":{ "shape":"SensitiveString", "documentation":"Type of the emission.
Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev
Type of the emission.
Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev
Name of the intersection, if applicable to the step.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details related to the enter highway step.
" }, "RouteExclusionOptions":{ "type":"structure", "required":["Countries"], "members":{ "Countries":{ "shape":"CountryCodeList", "documentation":"List of countries to be avoided defined by two-letter or three-letter country codes.
" } }, "documentation":"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.
" }, "RouteExitStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" }, "RelativeExit":{ "shape":"RouteExitStepDetailsRelativeExitInteger", "documentation":"Exit to be taken.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details related to the exit step.
" }, "RouteExitStepDetailsRelativeExitInteger":{ "type":"integer", "box":true, "max":12, "min":1, "sensitive":true }, "RouteFerryAfterTravelStep":{ "type":"structure", "required":[ "Duration", "Type" ], "members":{ "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
Unit: seconds
Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Type of the step.
" } }, "documentation":"Steps of a leg that must be performed after the travel portion of the leg.
" }, "RouteFerryAfterTravelStepList":{ "type":"list", "member":{"shape":"RouteFerryAfterTravelStep"} }, "RouteFerryAfterTravelStepType":{ "type":"string", "enum":["Deboard"], "sensitive":true }, "RouteFerryArrival":{ "type":"structure", "required":["Place"], "members":{ "Place":{ "shape":"RouteFerryPlace", "documentation":"The place details.
" }, "Time":{ "shape":"TimestampWithTimezoneOffset", "documentation":"The time.
" } }, "documentation":"Details corresponding to the arrival for the leg.
" }, "RouteFerryBeforeTravelStep":{ "type":"structure", "required":[ "Duration", "Type" ], "members":{ "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
Unit: seconds
Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Type of the step.
" } }, "documentation":"Steps of a leg that must be performed before the travel portion of the leg.
" }, "RouteFerryBeforeTravelStepList":{ "type":"list", "member":{"shape":"RouteFerryBeforeTravelStep"} }, "RouteFerryBeforeTravelStepType":{ "type":"string", "enum":["Board"], "sensitive":true }, "RouteFerryDeparture":{ "type":"structure", "required":["Place"], "members":{ "Place":{ "shape":"RouteFerryPlace", "documentation":"The place details.
" }, "Time":{ "shape":"TimestampWithTimezoneOffset", "documentation":"The time.
" } }, "documentation":"Details corresponding to the departure for the leg.
" }, "RouteFerryLegDetails":{ "type":"structure", "required":[ "AfterTravelSteps", "Arrival", "BeforeTravelSteps", "Departure", "Notices", "PassThroughWaypoints", "Spans", "TravelSteps" ], "members":{ "AfterTravelSteps":{ "shape":"RouteFerryAfterTravelStepList", "documentation":"Steps of a leg that must be performed after the travel portion of the leg.
" }, "Arrival":{ "shape":"RouteFerryArrival", "documentation":"Details corresponding to the arrival for the leg.
" }, "BeforeTravelSteps":{ "shape":"RouteFerryBeforeTravelStepList", "documentation":"Steps of a leg that must be performed before the travel portion of the leg.
" }, "Departure":{ "shape":"RouteFerryDeparture", "documentation":"Details corresponding to the departure for the leg.
" }, "Notices":{ "shape":"RouteFerryNoticeList", "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "PassThroughWaypoints":{ "shape":"RoutePassThroughWaypointList", "documentation":"Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
" }, "RouteName":{ "shape":"SensitiveString", "documentation":"Route name of the ferry line.
" }, "Spans":{ "shape":"RouteFerrySpanList", "documentation":"Spans that were computed for the requested SpanAdditionalFeatures.
" }, "Summary":{ "shape":"RouteFerrySummary", "documentation":"Summarized details of the leg.
" }, "TravelSteps":{ "shape":"RouteFerryTravelStepList", "documentation":"Steps of a leg that must be performed before the travel portion of the leg.
" } }, "documentation":"FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific
" }, "RouteFerryNotice":{ "type":"structure", "required":["Code"], "members":{ "Code":{ "shape":"RouteFerryNoticeCode", "documentation":"Code corresponding to the issue.
" }, "Impact":{ "shape":"RouteNoticeImpact", "documentation":"Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
" } }, "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "RouteFerryNoticeCode":{ "type":"string", "enum":[ "AccuratePolylineUnavailable", "NoSchedule", "Other", "ViolatedAvoidFerry", "ViolatedAvoidRailFerry", "SeasonalClosure", "PotentialViolatedVehicleRestrictionUsage" ] }, "RouteFerryNoticeList":{ "type":"list", "member":{"shape":"RouteFerryNotice"} }, "RouteFerryOverviewSummary":{ "type":"structure", "required":[ "Distance", "Duration" ], "members":{ "Distance":{ "shape":"DistanceMeters", "documentation":"Distance of the step.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
Unit: seconds
Summarized details of the leg.
" }, "RouteFerryPlace":{ "type":"structure", "required":["Position"], "members":{ "Name":{ "shape":"SensitiveString", "documentation":"The name of the place.
" }, "OriginalPosition":{ "shape":"Position23", "documentation":"Position provided in the request.
" }, "Position":{ "shape":"Position23", "documentation":"Position defined as [longitude, latitude].
Index of the waypoint in the request.
" } }, "documentation":"Position provided in the request.
" }, "RouteFerryPlaceWaypointIndexInteger":{ "type":"integer", "box":true, "min":0, "sensitive":true }, "RouteFerrySpan":{ "type":"structure", "members":{ "Country":{ "shape":"CountryCode3", "documentation":"3 letter Country code corresponding to the Span.
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"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
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
Offset in the leg geometry corresponding to the start of this span.
" }, "Names":{ "shape":"LocalizedStringList", "documentation":"Provides an array of names of the ferry span in available languages.
" }, "Region":{ "shape":"RouteFerrySpanRegionString", "documentation":"2-3 letter Region code corresponding to the Span. This is either a province or a state.
" } }, "documentation":"Span computed for the requested SpanAdditionalFeatures.
" }, "RouteFerrySpanGeometryOffsetInteger":{ "type":"integer", "box":true, "min":0 }, "RouteFerrySpanList":{ "type":"list", "member":{"shape":"RouteFerrySpan"} }, "RouteFerrySpanRegionString":{ "type":"string", "max":3, "min":0, "sensitive":true }, "RouteFerrySummary":{ "type":"structure", "members":{ "Overview":{ "shape":"RouteFerryOverviewSummary", "documentation":"Summarized details for the leg including before travel, travel and after travel steps.
" }, "TravelOnly":{ "shape":"RouteFerryTravelOnlySummary", "documentation":"Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" } }, "documentation":"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.
" }, "RouteFerryTravelOnlySummary":{ "type":"structure", "required":["Duration"], "members":{ "Duration":{ "shape":"DurationSeconds", "documentation":"Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
Unit: seconds
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.
" }, "RouteFerryTravelStep":{ "type":"structure", "required":[ "Duration", "Type" ], "members":{ "Distance":{ "shape":"DistanceMeters", "documentation":"Distance of the step.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
Unit: seconds
Offset in the leg geometry corresponding to the start of this step.
" }, "Instruction":{ "shape":"SensitiveString", "documentation":"Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Type of the step.
" } }, "documentation":"Steps of a leg that must be performed during the travel portion of the leg.
" }, "RouteFerryTravelStepGeometryOffsetInteger":{ "type":"integer", "box":true, "min":0 }, "RouteFerryTravelStepList":{ "type":"list", "member":{"shape":"RouteFerryTravelStep"} }, "RouteFerryTravelStepType":{ "type":"string", "enum":[ "Depart", "Continue", "Arrive" ], "sensitive":true }, "RouteHazardousCargoType":{ "type":"string", "enum":[ "Combustible", "Corrosive", "Explosive", "Flammable", "Gas", "HarmfulToWater", "Organic", "Other", "Poison", "PoisonousInhalation", "Radioactive" ], "sensitive":true }, "RouteHazardousCargoTypeList":{ "type":"list", "member":{"shape":"RouteHazardousCargoType"}, "max":11, "min":0 }, "RouteKeepStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details that are specific to a Keep step.
" }, "RouteLeg":{ "type":"structure", "required":[ "Geometry", "TravelMode", "Type" ], "members":{ "FerryLegDetails":{ "shape":"RouteFerryLegDetails", "documentation":"FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific
" }, "Geometry":{ "shape":"RouteLegGeometry", "documentation":"Geometry of the area to be avoided.
" }, "Language":{ "shape":"LanguageTag", "documentation":"List of languages for instructions within steps in the response.
" }, "PedestrianLegDetails":{ "shape":"RoutePedestrianLegDetails", "documentation":"Details related to the pedestrian leg.
" }, "TravelMode":{ "shape":"RouteLegTravelMode", "documentation":"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.
" }, "VehicleLegDetails":{ "shape":"RouteVehicleLegDetails", "documentation":"Details related to the vehicle leg.
" } }, "documentation":"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.
" }, "RouteLegAdditionalFeature":{ "type":"string", "enum":[ "Elevation", "Incidents", "PassThroughWaypoints", "Summary", "Tolls", "TravelStepInstructions", "TruckRoadTypes", "TypicalDuration", "Zones" ], "sensitive":true }, "RouteLegAdditionalFeatureList":{ "type":"list", "member":{"shape":"RouteLegAdditionalFeature"}, "max":9, "min":0 }, "RouteLegGeometry":{ "type":"structure", "members":{ "LineString":{ "shape":"LineString", "documentation":"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 in a lossy compression format.
LineString and Polyline are mutually exclusive properties.
The returned Route leg geometry.
" }, "RouteLegList":{ "type":"list", "member":{"shape":"RouteLeg"} }, "RouteLegTravelMode":{ "type":"string", "enum":[ "Car", "Ferry", "Pedestrian", "Scooter", "Truck", "CarShuttleTrain" ], "sensitive":true }, "RouteLegType":{ "type":"string", "enum":[ "Ferry", "Pedestrian", "Vehicle" ], "sensitive":true }, "RouteList":{ "type":"list", "member":{"shape":"Route"} }, "RouteMajorRoadLabel":{ "type":"structure", "members":{ "RoadName":{ "shape":"LocalizedString", "documentation":"Name of the road (localized).
" }, "RouteNumber":{ "shape":"RouteNumber", "documentation":"Route number of the road.
" } }, "documentation":"Important labels including names and route numbers that differentiate the current route from the alternatives presented.
" }, "RouteMajorRoadLabelsList":{ "type":"list", "member":{"shape":"RouteMajorRoadLabel"}, "max":2, "min":0 }, "RouteMatchingOptions":{ "type":"structure", "members":{ "NameHint":{ "shape":"RouteMatchingOptionsNameHintString", "documentation":"Attempts to match the provided position to a road similar to the provided name.
" }, "OnRoadThreshold":{ "shape":"DistanceMeters", "documentation":"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
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
" } }, "documentation":"Options related to route matching.
" }, "RouteMatchingOptionsNameHintString":{ "type":"string", "max":100, "min":0, "sensitive":true }, "RouteMatrix":{ "type":"list", "member":{"shape":"RouteMatrixRow"} }, "RouteMatrixAllowOptions":{ "type":"structure", "members":{ "Hot":{ "shape":"SensitiveBoolean", "documentation":"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
Allow Options related to the route matrix.
", "sensitive":true }, "RouteMatrixAutoCircle":{ "type":"structure", "members":{ "Margin":{ "shape":"RouteMatrixAutoCircleMarginLong", "documentation":"The margin provided for the calculation.
" }, "MaxRadius":{ "shape":"RouteMatrixAutoCircleMaxRadiusLong", "documentation":"The maximum size of the radius provided for the calculation.
" } }, "documentation":"Provides the circle that was used while calculating the route.
" }, "RouteMatrixAutoCircleMarginLong":{ "type":"long", "max":200000, "min":0, "sensitive":true }, "RouteMatrixAutoCircleMaxRadiusLong":{ "type":"long", "max":200000, "min":0, "sensitive":true }, "RouteMatrixAvoidanceArea":{ "type":"structure", "required":["Geometry"], "members":{ "Geometry":{ "shape":"RouteMatrixAvoidanceAreaGeometry", "documentation":"Geometry of the area to be avoided.
" } }, "documentation":"Area to be avoided.
" }, "RouteMatrixAvoidanceAreaGeometry":{ "type":"structure", "members":{ "BoundingBox":{ "shape":"BoundingBox", "documentation":"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.
" }, "Polygon":{ "shape":"RouteMatrixAvoidanceAreaGeometryPolygonList", "documentation":"Geometry defined as a polygon with only one linear ring.
" }, "PolylinePolygon":{ "shape":"RouteMatrixAvoidanceAreaGeometryPolylinePolygonList", "documentation":"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/heremaps/flexiblepolyline/blob/master/README.md.
" } }, "documentation":"Geometry of the area to be avoided.
" }, "RouteMatrixAvoidanceAreaGeometryPolygonList":{ "type":"list", "member":{"shape":"LinearRing"}, "max":1, "min":1 }, "RouteMatrixAvoidanceAreaGeometryPolylinePolygonList":{ "type":"list", "member":{"shape":"PolylineRing"}, "max":1, "min":1 }, "RouteMatrixAvoidanceOptions":{ "type":"structure", "members":{ "Areas":{ "shape":"RouteMatrixAvoidanceOptionsAreasList", "documentation":"Areas to be avoided.
" }, "CarShuttleTrains":{ "shape":"SensitiveBoolean", "documentation":"Avoid car-shuttle-trains while calculating the route.
" }, "ControlledAccessHighways":{ "shape":"SensitiveBoolean", "documentation":"Avoid controlled access highways while calculating the route.
" }, "DirtRoads":{ "shape":"SensitiveBoolean", "documentation":"Avoid dirt roads while calculating the route.
" }, "Ferries":{ "shape":"SensitiveBoolean", "documentation":"Avoid ferries while calculating the route.
" }, "TollRoads":{ "shape":"SensitiveBoolean", "documentation":"Avoids roads where the specified toll transponders are the only mode of payment.
" }, "TollTransponders":{ "shape":"SensitiveBoolean", "documentation":"Avoids roads where the specified toll transponders are the only mode of payment.
" }, "TruckRoadTypes":{ "shape":"TruckRoadTypeList", "documentation":"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.
Avoid tunnels while calculating the route.
" }, "UTurns":{ "shape":"SensitiveBoolean", "documentation":"Avoid U-turns for calculation on highways and motorways.
" }, "ZoneCategories":{ "shape":"RouteMatrixAvoidanceZoneCategoryList", "documentation":"Zone categories to be avoided.
" } }, "documentation":"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.
" }, "RouteMatrixAvoidanceOptionsAreasList":{ "type":"list", "member":{"shape":"RouteMatrixAvoidanceArea"}, "max":250, "min":0 }, "RouteMatrixAvoidanceZoneCategory":{ "type":"structure", "members":{ "Category":{ "shape":"RouteMatrixZoneCategory", "documentation":"Zone category to be avoided.
" } }, "documentation":"Zone categories to be avoided.
" }, "RouteMatrixAvoidanceZoneCategoryList":{ "type":"list", "member":{"shape":"RouteMatrixAvoidanceZoneCategory"}, "max":3, "min":0 }, "RouteMatrixBoundary":{ "type":"structure", "members":{ "Geometry":{ "shape":"RouteMatrixBoundaryGeometry", "documentation":"Geometry of the area to be avoided.
" }, "Unbounded":{ "shape":"SensitiveBoolean", "documentation":"No restrictions in terms of a routing boundary, and is typically used for longer routes.
" } }, "documentation":"Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.
" }, "RouteMatrixBoundaryGeometry":{ "type":"structure", "members":{ "AutoCircle":{ "shape":"RouteMatrixAutoCircle", "documentation":"Provides the circle that was used while calculating the route.
" }, "Circle":{ "shape":"Circle", "documentation":"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 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.
" }, "Polygon":{ "shape":"RouteMatrixBoundaryGeometryPolygonList", "documentation":"Geometry defined as a polygon with only one linear ring.
" } }, "documentation":"Geometry of the routing boundary.
" }, "RouteMatrixBoundaryGeometryPolygonList":{ "type":"list", "member":{"shape":"LinearRing"}, "max":1, "min":1 }, "RouteMatrixCarOptions":{ "type":"structure", "members":{ "LicensePlate":{ "shape":"RouteMatrixVehicleLicensePlate", "documentation":"The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"RouteMatrixCarOptionsMaxSpeedDouble", "documentation":"Maximum speed
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Travel mode options when the provided travel mode is Car.
Destination related options.
" }, "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
The route destination.
" }, "RouteMatrixDestinationOptions":{ "type":"structure", "members":{ "AvoidActionsForDistance":{ "shape":"RouteMatrixDestinationOptionsAvoidActionsForDistanceLong", "documentation":"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.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Matching":{ "shape":"RouteMatrixMatchingOptions", "documentation":"Options to configure matching the provided position to the road network.
" }, "SideOfStreet":{ "shape":"RouteMatrixSideOfStreetOptions", "documentation":"Options to configure matching the provided position to a side of the street.
" } }, "documentation":"Options related to the destination.
" }, "RouteMatrixDestinationOptionsAvoidActionsForDistanceLong":{ "type":"long", "min":0, "sensitive":true }, "RouteMatrixEntry":{ "type":"structure", "required":[ "Distance", "Duration" ], "members":{ "Distance":{ "shape":"DistanceMeters", "documentation":"The total distance of travel for the route.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"The expected duration of travel for the route.
Unit: seconds
Error code that occurred during calculation of the route.
" } }, "documentation":"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.
" }, "RouteMatrixErrorCode":{ "type":"string", "enum":[ "NoMatch", "NoMatchDestination", "NoMatchOrigin", "NoRoute", "OutOfBounds", "OutOfBoundsDestination", "OutOfBoundsOrigin", "Other", "Violation" ] }, "RouteMatrixExclusionOptions":{ "type":"structure", "required":["Countries"], "members":{ "Countries":{ "shape":"CountryCodeList", "documentation":"List of countries to be avoided defined by two-letter or three-letter country codes.
" } }, "documentation":"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.
" }, "RouteMatrixHazardousCargoType":{ "type":"string", "enum":[ "Combustible", "Corrosive", "Explosive", "Flammable", "Gas", "HarmfulToWater", "Organic", "Other", "Poison", "PoisonousInhalation", "Radioactive" ], "sensitive":true }, "RouteMatrixHazardousCargoTypeList":{ "type":"list", "member":{"shape":"RouteMatrixHazardousCargoType"}, "max":11, "min":0 }, "RouteMatrixMatchingOptions":{ "type":"structure", "members":{ "NameHint":{ "shape":"SensitiveString", "documentation":"Attempts to match the provided position to a road similar to the provided name.
" }, "OnRoadThreshold":{ "shape":"RouteMatrixMatchingOptionsOnRoadThresholdLong", "documentation":"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
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
" } }, "documentation":"Matching options.
" }, "RouteMatrixMatchingOptionsOnRoadThresholdLong":{ "type":"long", "min":0, "sensitive":true }, "RouteMatrixOrigin":{ "type":"structure", "required":["Position"], "members":{ "Options":{ "shape":"RouteMatrixOriginOptions", "documentation":"Origin related options.
" }, "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
The start position for the route.
" }, "RouteMatrixOriginOptions":{ "type":"structure", "members":{ "AvoidActionsForDistance":{ "shape":"RouteMatrixOriginOptionsAvoidActionsForDistanceLong", "documentation":"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.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Matching":{ "shape":"RouteMatrixMatchingOptions", "documentation":"Options to configure matching the provided position to the road network.
" }, "SideOfStreet":{ "shape":"RouteMatrixSideOfStreetOptions", "documentation":"Options to configure matching the provided position to a side of the street.
" } }, "documentation":"Origin related options.
" }, "RouteMatrixOriginOptionsAvoidActionsForDistanceLong":{ "type":"long", "min":0, "sensitive":true }, "RouteMatrixRow":{ "type":"list", "member":{"shape":"RouteMatrixEntry"} }, "RouteMatrixScooterOptions":{ "type":"structure", "members":{ "LicensePlate":{ "shape":"RouteMatrixVehicleLicensePlate", "documentation":"The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"RouteMatrixScooterOptionsMaxSpeedDouble", "documentation":"Maximum speed.
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Travel mode options when the provided travel mode is Scooter
Position defined as [longitude, latitude].
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
Default Value: DividedStreetOnly
Options to configure matching the provided position to a side of the street.
" }, "RouteMatrixTrafficOptions":{ "type":"structure", "members":{ "FlowEventThresholdOverride":{ "shape":"DurationSeconds", "documentation":"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.
" }, "Usage":{ "shape":"TrafficUsage", "documentation":"Determines if traffic should be used or ignored while calculating the route.
Default Value: UseTrafficData
Traffic related options.
" }, "RouteMatrixTrailerOptions":{ "type":"structure", "members":{ "TrailerCount":{ "shape":"RouteMatrixTrailerOptionsTrailerCountInteger", "documentation":"Number of trailers attached to the vehicle.
Default Value: 0
Trailer options corresponding to the vehicle.
" }, "RouteMatrixTrailerOptionsTrailerCountInteger":{ "type":"integer", "box":true, "max":255, "min":0, "sensitive":true }, "RouteMatrixTravelMode":{ "type":"string", "enum":[ "Car", "Pedestrian", "Scooter", "Truck" ] }, "RouteMatrixTravelModeOptions":{ "type":"structure", "members":{ "Car":{ "shape":"RouteMatrixCarOptions", "documentation":"Travel mode options when the provided travel mode is \"Car\"
" }, "Scooter":{ "shape":"RouteMatrixScooterOptions", "documentation":"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.
Travel mode options when the provided travel mode is \"Truck\"
" } }, "documentation":"Travel mode related options for the provided travel mode.
" }, "RouteMatrixTruckOptions":{ "type":"structure", "members":{ "AxleCount":{ "shape":"RouteMatrixTruckOptionsAxleCountInteger", "documentation":"Total number of axles of the vehicle.
" }, "GrossWeight":{ "shape":"WeightKilograms", "documentation":"Gross weight of the vehicle including trailers, and goods at capacity.
Unit: Kilograms
List of Hazardous cargo contained in the vehicle.
" }, "Height":{ "shape":"RouteMatrixTruckOptionsHeightLong", "documentation":"Height of the vehicle.
Unit: centimeters
Kingpin to rear axle length of the vehicle
Unit: centimeters
Length of the vehicle.
Unit: centimeters
The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"RouteMatrixTruckOptionsMaxSpeedDouble", "documentation":"Maximum speed
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Payload capacity of the vehicle and trailers attached.
Unit: kilograms
Trailer options corresponding to the vehicle.
" }, "TruckType":{ "shape":"RouteMatrixTruckType", "documentation":"Type of the truck.
" }, "TunnelRestrictionCode":{ "shape":"TunnelRestrictionCode", "documentation":"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
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
Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.
" }, "Width":{ "shape":"RouteMatrixTruckOptionsWidthLong", "documentation":"Width of the vehicle.
Unit: centimeters
Travel mode options when the provided travel mode is \"Truck\"
" }, "RouteMatrixTruckOptionsAxleCountInteger":{ "type":"integer", "box":true, "max":255, "min":2, "sensitive":true }, "RouteMatrixTruckOptionsHeightLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "RouteMatrixTruckOptionsLengthLong":{ "type":"long", "max":30000, "min":0, "sensitive":true }, "RouteMatrixTruckOptionsMaxSpeedDouble":{ "type":"double", "max":252.0, "min":3.6, "sensitive":true }, "RouteMatrixTruckOptionsOccupancyInteger":{ "type":"integer", "box":true, "min":1, "sensitive":true }, "RouteMatrixTruckOptionsWidthLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "RouteMatrixTruckType":{ "type":"string", "enum":[ "LightTruck", "StraightTruck", "Tractor" ], "sensitive":true }, "RouteMatrixVehicleLicensePlate":{ "type":"structure", "members":{ "LastCharacter":{ "shape":"RouteMatrixVehicleLicensePlateLastCharacterString", "documentation":"The last character of the License Plate.
" } }, "documentation":"The vehicle License Plate.
", "sensitive":true }, "RouteMatrixVehicleLicensePlateLastCharacterString":{ "type":"string", "max":1, "min":1 }, "RouteMatrixZoneCategory":{ "type":"string", "enum":[ "CongestionPricing", "Environmental", "Vignette" ], "sensitive":true }, "RouteNoticeDetailRange":{ "type":"structure", "members":{ "Min":{ "shape":"RouteNoticeDetailRangeMinInteger", "documentation":"Minimum value for the range.
" }, "Max":{ "shape":"RouteNoticeDetailRangeMaxInteger", "documentation":"Maximum value for the range.
" } }, "documentation":"Notice Detail that is a range.
" }, "RouteNoticeDetailRangeMaxInteger":{ "type":"integer", "box":true, "min":0 }, "RouteNoticeDetailRangeMinInteger":{ "type":"integer", "box":true, "min":0 }, "RouteNoticeImpact":{ "type":"string", "enum":[ "High", "Low" ] }, "RouteNumber":{ "type":"structure", "required":["Value"], "members":{ "Direction":{ "shape":"RouteDirection", "documentation":"Directional identifier of the route.
" }, "Language":{ "shape":"LanguageTag", "documentation":"List of languages for instructions corresponding to the route number.
" }, "Value":{ "shape":"SensitiveString", "documentation":"The route number.
" } }, "documentation":"The route number.
" }, "RouteNumberList":{ "type":"list", "member":{"shape":"RouteNumber"} }, "RouteOriginOptions":{ "type":"structure", "members":{ "AvoidActionsForDistance":{ "shape":"RouteOriginOptionsAvoidActionsForDistanceLong", "documentation":"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.
" }, "AvoidUTurns":{ "shape":"SensitiveBoolean", "documentation":"Avoid U-turns for calculation on highways and motorways.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Matching":{ "shape":"RouteMatchingOptions", "documentation":"Options to configure matching the provided position to the road network.
" }, "SideOfStreet":{ "shape":"RouteSideOfStreetOptions", "documentation":"Options to configure matching the provided position to a side of the street.
" } }, "documentation":"Origin related options.
" }, "RouteOriginOptionsAvoidActionsForDistanceLong":{ "type":"long", "max":2000, "sensitive":true }, "RoutePassThroughPlace":{ "type":"structure", "required":["Position"], "members":{ "OriginalPosition":{ "shape":"Position23", "documentation":"Position provided in the request.
" }, "Position":{ "shape":"Position23", "documentation":"Position defined as [longitude, latitude].
Index of the waypoint in the request.
" } }, "documentation":"The place where the waypoint is passed through and not treated as a stop.
" }, "RoutePassThroughPlaceWaypointIndexInteger":{ "type":"integer", "box":true, "min":0, "sensitive":true }, "RoutePassThroughWaypoint":{ "type":"structure", "required":["Place"], "members":{ "GeometryOffset":{ "shape":"RoutePassThroughWaypointGeometryOffsetInteger", "documentation":"Offset in the leg geometry corresponding to the start of this step.
" }, "Place":{ "shape":"RoutePassThroughPlace", "documentation":"The place details.
" } }, "documentation":"If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.
" }, "RoutePassThroughWaypointGeometryOffsetInteger":{ "type":"integer", "box":true, "min":0 }, "RoutePassThroughWaypointList":{ "type":"list", "member":{"shape":"RoutePassThroughWaypoint"} }, "RoutePedestrianArrival":{ "type":"structure", "required":["Place"], "members":{ "Place":{ "shape":"RoutePedestrianPlace", "documentation":"The place details.
" }, "Time":{ "shape":"TimestampWithTimezoneOffset", "documentation":"The time.
" } }, "documentation":"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
The place details.
" }, "Time":{ "shape":"TimestampWithTimezoneOffset", "documentation":"The time.
" } }, "documentation":"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 arrival for the leg.
" }, "Departure":{ "shape":"RoutePedestrianDeparture", "documentation":"Details corresponding to the departure for the leg.
" }, "Notices":{ "shape":"RoutePedestrianNoticeList", "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "PassThroughWaypoints":{ "shape":"RoutePassThroughWaypointList", "documentation":"Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
" }, "Spans":{ "shape":"RoutePedestrianSpanList", "documentation":"Spans that were computed for the requested SpanAdditionalFeatures.
" }, "Summary":{ "shape":"RoutePedestrianSummary", "documentation":"Summarized details of the leg.
" }, "TravelSteps":{ "shape":"RoutePedestrianTravelStepList", "documentation":"Steps of a leg that must be performed before the travel portion of the leg.
" } }, "documentation":"Details that are specific to a pedestrian leg.
" }, "RoutePedestrianNotice":{ "type":"structure", "required":["Code"], "members":{ "Code":{ "shape":"RoutePedestrianNoticeCode", "documentation":"Code corresponding to the issue.
" }, "Impact":{ "shape":"RouteNoticeImpact", "documentation":"Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
" } }, "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "RoutePedestrianNoticeCode":{ "type":"string", "enum":[ "AccuratePolylineUnavailable", "Other", "ViolatedAvoidDirtRoad", "ViolatedAvoidTunnel", "ViolatedPedestrianOption" ] }, "RoutePedestrianNoticeList":{ "type":"list", "member":{"shape":"RoutePedestrianNotice"} }, "RoutePedestrianOptions":{ "type":"structure", "members":{ "Speed":{ "shape":"RoutePedestrianOptionsSpeedDouble", "documentation":"Walking speed in Kilometers per hour.
", "box":true } }, "documentation":"Options related to the pedestrian.
" }, "RoutePedestrianOptionsSpeedDouble":{ "type":"double", "max":7.2, "min":1.8, "sensitive":true }, "RoutePedestrianOverviewSummary":{ "type":"structure", "required":[ "Distance", "Duration" ], "members":{ "Distance":{ "shape":"DistanceMeters", "documentation":"Distance of the step.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
" } }, "documentation":"Provides a summary of a pedestrian route step.
" }, "RoutePedestrianPlace":{ "type":"structure", "required":["Position"], "members":{ "Name":{ "shape":"SensitiveString", "documentation":"The name of the place.
" }, "OriginalPosition":{ "shape":"Position23", "documentation":"Position provided in the request.
" }, "Position":{ "shape":"Position23", "documentation":"Position defined as [longitude, latitude].
Options to configure matching the provided position to a side of the street.
" }, "WaypointIndex":{ "shape":"RoutePedestrianPlaceWaypointIndexInteger", "documentation":"Index of the waypoint in the request.
" } }, "documentation":"Place details corresponding to the arrival or departure.
" }, "RoutePedestrianPlaceWaypointIndexInteger":{ "type":"integer", "box":true, "min":0, "sensitive":true }, "RoutePedestrianSpan":{ "type":"structure", "members":{ "BestCaseDuration":{ "shape":"DurationSeconds", "documentation":"Duration of the computed span without traffic congestion.
Unit: seconds
3 letter Country code corresponding to the Span.
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"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
Dynamic speed details corresponding to the span.
Unit: KilometersPerHour
Functional classification of the road segment corresponding to the span.
" }, "GeometryOffset":{ "shape":"RoutePedestrianSpanGeometryOffsetInteger", "documentation":"Offset in the leg geometry corresponding to the start of this span.
" }, "Incidents":{ "shape":"IndexList", "documentation":"Incidents corresponding to the span. These index into the Incidents in the parent Leg.
" }, "Names":{ "shape":"LocalizedStringList", "documentation":"Provides an array of names of the pedestrian span in available languages.
" }, "PedestrianAccess":{ "shape":"RouteSpanPedestrianAccessAttributeList", "documentation":"Access attributes for a pedestrian corresponding to the span.
" }, "Region":{ "shape":"RoutePedestrianSpanRegionString", "documentation":"2-3 letter Region code corresponding to the Span. This is either a province or a state.
" }, "RoadAttributes":{ "shape":"RouteSpanRoadAttributeList", "documentation":"Attributes for the road segment corresponding to the span.
" }, "RouteNumbers":{ "shape":"RouteNumberList", "documentation":"Designated route name or number corresponding to the span.
" }, "SpeedLimit":{ "shape":"RouteSpanSpeedLimitDetails", "documentation":"Speed limit details corresponding to the span.
Unit: KilometersPerHour
Duration of the computed span under typical traffic congestion.
Unit: seconds
Span computed for the requested SpanAdditionalFeatures.
" }, "RoutePedestrianSpanFunctionalClassificationInteger":{ "type":"integer", "box":true, "max":5, "min":1, "sensitive":true }, "RoutePedestrianSpanGeometryOffsetInteger":{ "type":"integer", "box":true, "min":0 }, "RoutePedestrianSpanList":{ "type":"list", "member":{"shape":"RoutePedestrianSpan"} }, "RoutePedestrianSpanRegionString":{ "type":"string", "max":3, "min":0, "sensitive":true }, "RoutePedestrianSummary":{ "type":"structure", "members":{ "Overview":{ "shape":"RoutePedestrianOverviewSummary", "documentation":"Summarized details for the leg including before travel, travel and after travel steps.
" }, "TravelOnly":{ "shape":"RoutePedestrianTravelOnlySummary", "documentation":"Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" } }, "documentation":"Summarized details for the leg including before travel, travel and after travel steps.
" }, "RoutePedestrianTravelOnlySummary":{ "type":"structure", "required":["Duration"], "members":{ "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
Unit: seconds
Summarized details for the leg including travel steps.
" }, "RoutePedestrianTravelStep":{ "type":"structure", "required":[ "Duration", "Type" ], "members":{ "ContinueStepDetails":{ "shape":"RouteContinueStepDetails", "documentation":"Details related to the continue step.
" }, "CurrentRoad":{ "shape":"RouteRoad", "documentation":"Details of the current road. See RouteRoad for details of sub-attributes.
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"Distance of the step.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
Unit: seconds
Exit number of the road exit, if applicable.
" }, "GeometryOffset":{ "shape":"RoutePedestrianTravelStepGeometryOffsetInteger", "documentation":"Offset in the leg geometry corresponding to the start of this step.
" }, "Instruction":{ "shape":"SensitiveString", "documentation":"Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Details that are specific to a Keep step.
" }, "NextRoad":{ "shape":"RouteRoad", "documentation":"Details of the next road. See RouteRoad for details of sub-attributes.
" }, "RoundaboutEnterStepDetails":{ "shape":"RouteRoundaboutEnterStepDetails", "documentation":"Details that are specific to a Roundabout Enter step.
" }, "RoundaboutExitStepDetails":{ "shape":"RouteRoundaboutExitStepDetails", "documentation":"Details that are specific to a Roundabout Exit step.
" }, "RoundaboutPassStepDetails":{ "shape":"RouteRoundaboutPassStepDetails", "documentation":"Details that are specific to a Roundabout Pass step.
" }, "Signpost":{ "shape":"RouteSignpost", "documentation":"Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
" }, "TurnStepDetails":{ "shape":"RouteTurnStepDetails", "documentation":"Details that are specific to a turn step.
" }, "Type":{ "shape":"RoutePedestrianTravelStepType", "documentation":"Type of the step.
" } }, "documentation":"Steps of a leg that must be performed during the travel portion of the leg.
" }, "RoutePedestrianTravelStepGeometryOffsetInteger":{ "type":"integer", "box":true, "min":0 }, "RoutePedestrianTravelStepList":{ "type":"list", "member":{"shape":"RoutePedestrianTravelStep"} }, "RoutePedestrianTravelStepType":{ "type":"string", "enum":[ "Arrive", "Continue", "Depart", "Keep", "RoundaboutEnter", "RoundaboutExit", "RoundaboutPass", "Turn", "Exit", "Ramp", "UTurn" ], "sensitive":true }, "RouteRampStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details that are specific to a ramp step.
" }, "RouteResponseNotice":{ "type":"structure", "required":["Code"], "members":{ "Code":{ "shape":"RouteResponseNoticeCode", "documentation":"Code corresponding to the issue.
" }, "Impact":{ "shape":"RouteNoticeImpact", "documentation":"Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
" } }, "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "RouteResponseNoticeCode":{ "type":"string", "enum":[ "MainLanguageNotFound", "Other", "TravelTimeExceedsDriverWorkHours" ] }, "RouteResponseNoticeList":{ "type":"list", "member":{"shape":"RouteResponseNotice"} }, "RouteRoad":{ "type":"structure", "required":[ "RoadName", "RouteNumber", "Towards" ], "members":{ "RoadName":{ "shape":"LocalizedStringList", "documentation":"Name of the road (localized).
" }, "RouteNumber":{ "shape":"RouteNumberList", "documentation":"Route number of the road.
" }, "Towards":{ "shape":"LocalizedStringList", "documentation":"Names of destinations that can be reached when traveling on the road.
" }, "Type":{ "shape":"RouteRoadType", "documentation":"The type of road.
" } }, "documentation":"The road on the route.
" }, "RouteRoadType":{ "type":"string", "enum":[ "Highway", "Rural", "Urban" ], "sensitive":true }, "RouteRoundaboutEnterStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details about the roundabout leg.
" }, "RouteRoundaboutExitStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" }, "RelativeExit":{ "shape":"RouteRoundaboutExitStepDetailsRelativeExitInteger", "documentation":"Exit to be taken.
" }, "RoundaboutAngle":{ "shape":"RoundaboutAngle", "documentation":"Angle of the roundabout.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" } }, "documentation":"Details about the roundabout step.
" }, "RouteRoundaboutExitStepDetailsRelativeExitInteger":{ "type":"integer", "box":true, "max":12, "min":1, "sensitive":true }, "RouteRoundaboutPassStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details about the step.
" }, "RouteScooterOptions":{ "type":"structure", "members":{ "EngineType":{ "shape":"RouteEngineType", "documentation":"Engine type of the vehicle.
" }, "LicensePlate":{ "shape":"RouteVehicleLicensePlate", "documentation":"The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"RouteScooterOptionsMaxSpeedDouble", "documentation":"Maximum speed
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Travel mode options when the provided travel mode is Scooter
Position defined as [longitude, latitude].
Strategy that defines when the side of street position should be used.
Default Value: DividedStreetOnly
Options to configure matching the provided position to a side of the street.
" }, "RouteSignpost":{ "type":"structure", "required":["Labels"], "members":{ "Labels":{ "shape":"RouteSignpostLabelList", "documentation":"Labels present on the sign post.
" } }, "documentation":"Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
" }, "RouteSignpostLabel":{ "type":"structure", "members":{ "RouteNumber":{ "shape":"RouteNumber", "documentation":"Route number of the road.
" }, "Text":{ "shape":"LocalizedString", "documentation":"The Signpost text.
" } }, "documentation":"Labels presented on the sign post.
" }, "RouteSignpostLabelList":{ "type":"list", "member":{"shape":"RouteSignpostLabel"} }, "RouteSpanAdditionalFeature":{ "type":"string", "enum":[ "BestCaseDuration", "CarAccess", "Country", "Distance", "Duration", "DynamicSpeed", "FunctionalClassification", "Gates", "Incidents", "Names", "Notices", "PedestrianAccess", "RailwayCrossings", "Region", "RoadAttributes", "RouteNumbers", "ScooterAccess", "SpeedLimit", "TollSystems", "TruckAccess", "TruckRoadTypes", "TypicalDuration", "Zones", "Consumption" ] }, "RouteSpanAdditionalFeatureList":{ "type":"list", "member":{"shape":"RouteSpanAdditionalFeature"}, "max":24, "min":0 }, "RouteSpanCarAccessAttribute":{ "type":"string", "enum":[ "Allowed", "NoThroughTraffic", "TollRoad" ], "sensitive":true }, "RouteSpanCarAccessAttributeList":{ "type":"list", "member":{"shape":"RouteSpanCarAccessAttribute"}, "max":3, "min":0 }, "RouteSpanDynamicSpeedDetails":{ "type":"structure", "members":{ "BestCaseSpeed":{ "shape":"SpeedKilometersPerHour", "documentation":"Estimated speed while traversing the span without traffic congestion.
Unit: KilometersPerHour
Estimated time to turn from this span into the next.
Unit: seconds
Estimated speed while traversing the span under typical traffic congestion.
Unit: KilometersPerHour
Details about the dynamic speed.
Unit: KilometersPerHour
Maximum speed.
Unit: KilometersPerHour
If the span doesn't have a speed limit like the Autobahn.
" } }, "documentation":"Details about the speed limit corresponding to the span.
Unit: KilometersPerHour
Distance of the route.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the route.
Unit: seconds
Toll summary for the complete route.
" } }, "documentation":"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.
" }, "RouteToll":{ "type":"structure", "required":[ "PaymentSites", "Rates", "Systems" ], "members":{ "Country":{ "shape":"CountryCode3", "documentation":"The alpha-2 or alpha-3 character code for the country.
" }, "PaymentSites":{ "shape":"RouteTollPaymentSiteList", "documentation":"Locations or sites where the toll fare is collected.
" }, "Rates":{ "shape":"RouteTollRateList", "documentation":"Toll rates that need to be paid to travel this leg of the route.
" }, "Systems":{ "shape":"IndexList", "documentation":"Toll systems are authorities that collect payments for the toll.
" } }, "documentation":"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.
" }, "RouteTollList":{ "type":"list", "member":{"shape":"RouteToll"} }, "RouteTollOptions":{ "type":"structure", "members":{ "AllTransponders":{ "shape":"SensitiveBoolean", "documentation":"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.
" }, "AllVignettes":{ "shape":"SensitiveBoolean", "documentation":"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.
" }, "Currency":{ "shape":"CurrencyCode", "documentation":"Currency code corresponding to the price. This is the same as Currency specified in the request.
" }, "EmissionType":{ "shape":"RouteEmissionType", "documentation":"Emission type of the vehicle for toll cost calculation.
Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev
Vehicle category for toll cost calculation.
" } }, "documentation":"Options related to Tolls on a route.
" }, "RouteTollPass":{ "type":"structure", "members":{ "IncludesReturnTrip":{ "shape":"SensitiveBoolean", "documentation":"If the pass includes the rate for the return leg of the trip.
" }, "SeniorPass":{ "shape":"SensitiveBoolean", "documentation":"If the pass is only valid for senior persons.
" }, "TransferCount":{ "shape":"RouteTollPassTransferCountInteger", "documentation":"If the toll pass can be transferred, and how many times.
" }, "TripCount":{ "shape":"RouteTollPassTripCountInteger", "documentation":"Number of trips the pass is valid for.
" }, "ValidityPeriod":{ "shape":"RouteTollPassValidityPeriod", "documentation":"Period for which the pass is valid.
" } }, "documentation":"Details if the toll rate can be a pass that supports multiple trips.
" }, "RouteTollPassTransferCountInteger":{ "type":"integer", "box":true, "min":0, "sensitive":true }, "RouteTollPassTripCountInteger":{ "type":"integer", "box":true, "min":0, "sensitive":true }, "RouteTollPassValidityPeriod":{ "type":"structure", "required":["Period"], "members":{ "Period":{ "shape":"RouteTollPassValidityPeriodType", "documentation":"Validity period.
" }, "PeriodCount":{ "shape":"RouteTollPassValidityPeriodPeriodCountInteger", "documentation":"Counts for the validity period.
" } }, "documentation":"Period for which the pass is valid.
" }, "RouteTollPassValidityPeriodPeriodCountInteger":{ "type":"integer", "box":true, "min":0, "sensitive":true }, "RouteTollPassValidityPeriodType":{ "type":"string", "enum":[ "Annual", "Days", "ExtendedAnnual", "Minutes", "Months" ], "sensitive":true }, "RouteTollPaymentMethod":{ "type":"string", "enum":[ "BankCard", "Cash", "CashExact", "CreditCard", "PassSubscription", "TravelCard", "Transponder", "VideoToll" ], "sensitive":true }, "RouteTollPaymentMethodList":{ "type":"list", "member":{"shape":"RouteTollPaymentMethod"}, "max":8, "min":0 }, "RouteTollPaymentSite":{ "type":"structure", "required":["Position"], "members":{ "Name":{ "shape":"String", "documentation":"Name of the payment site.
" }, "Position":{ "shape":"Position23", "documentation":"Position defined as [longitude, latitude].
Locations or sites where the toll fare is collected.
" }, "RouteTollPaymentSiteList":{ "type":"list", "member":{"shape":"RouteTollPaymentSite"} }, "RouteTollPrice":{ "type":"structure", "required":[ "Currency", "Estimate", "Range", "Value" ], "members":{ "Currency":{ "shape":"CurrencyCode", "documentation":"Currency code corresponding to the price. This is the same as Currency specified in the request.
" }, "Estimate":{ "shape":"SensitiveBoolean", "documentation":"If the price is an estimate or an exact value.
" }, "PerDuration":{ "shape":"DurationSeconds", "documentation":"Duration for which the price corresponds to.
Unit: seconds
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.
" }, "RangeValue":{ "shape":"RouteTollPriceValueRange", "documentation":"Price range with a minimum and maximum value, if a range.
" }, "Value":{ "shape":"RouteTollPriceValueDouble", "documentation":"Exact price, if not a range.
" } }, "documentation":"The toll price.
" }, "RouteTollPriceSummary":{ "type":"structure", "required":[ "Currency", "Estimate", "Range", "Value" ], "members":{ "Currency":{ "shape":"CurrencyCode", "documentation":"Currency code corresponding to the price. This is the same as Currency specified in the request.
" }, "Estimate":{ "shape":"SensitiveBoolean", "documentation":"If the price is an estimate or an exact value.
" }, "Range":{ "shape":"SensitiveBoolean", "documentation":"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.
" }, "RangeValue":{ "shape":"RouteTollPriceValueRange", "documentation":"Price range with a minimum and maximum value, if a range.
" }, "Value":{ "shape":"RouteTollPriceSummaryValueDouble", "documentation":"Exact price, if not a range.
" } }, "documentation":"Summary of the route and toll price.
" }, "RouteTollPriceSummaryValueDouble":{ "type":"double", "box":true, "min":0.0, "sensitive":true }, "RouteTollPriceValueDouble":{ "type":"double", "box":true, "min":0.0, "sensitive":true }, "RouteTollPriceValueRange":{ "type":"structure", "required":[ "Min", "Max" ], "members":{ "Min":{ "shape":"RouteTollPriceValueRangeMinDouble", "documentation":"Minimum price.
" }, "Max":{ "shape":"RouteTollPriceValueRangeMaxDouble", "documentation":"Maximum price.
" } }, "documentation":"Price range with a minimum and maximum value, if a range.
" }, "RouteTollPriceValueRangeMaxDouble":{ "type":"double", "box":true, "min":0.0, "sensitive":true }, "RouteTollPriceValueRangeMinDouble":{ "type":"double", "box":true, "min":0.0, "sensitive":true }, "RouteTollRate":{ "type":"structure", "required":[ "Id", "LocalPrice", "Name", "PaymentMethods", "Transponders" ], "members":{ "ApplicableTimes":{ "shape":"SensitiveString", "documentation":"Time when the rate is valid.
" }, "ConvertedPrice":{ "shape":"RouteTollPrice", "documentation":"Price in the converted currency as specified in the request.
" }, "Id":{ "shape":"SensitiveString", "documentation":"The Toll rate Id.
" }, "LocalPrice":{ "shape":"RouteTollPrice", "documentation":"Price in the local regional currency.
" }, "Name":{ "shape":"SensitiveString", "documentation":"The name of the toll.
" }, "Pass":{ "shape":"RouteTollPass", "documentation":"Details if the toll rate can be a pass that supports multiple trips.
" }, "PaymentMethods":{ "shape":"RouteTollPaymentMethodList", "documentation":"Accepted payment methods at the toll.
" }, "Transponders":{ "shape":"RouteTransponderList", "documentation":"Transponders for which this toll can be applied.
" } }, "documentation":"The toll rate.
" }, "RouteTollRateList":{ "type":"list", "member":{"shape":"RouteTollRate"} }, "RouteTollSummary":{ "type":"structure", "members":{ "Total":{ "shape":"RouteTollPriceSummary", "documentation":"Total toll summary for the complete route. Total is the only summary available today.
" } }, "documentation":"The toll summary for the complete route.
" }, "RouteTollSystem":{ "type":"structure", "members":{ "Name":{ "shape":"SensitiveString", "documentation":"The toll system name.
" } }, "documentation":"Toll systems are authorities that collect payments for the toll.
" }, "RouteTollSystemList":{ "type":"list", "member":{"shape":"RouteTollSystem"} }, "RouteTollVehicleCategory":{ "type":"string", "enum":["Minibus"], "sensitive":true }, "RouteTrafficOptions":{ "type":"structure", "members":{ "FlowEventThresholdOverride":{ "shape":"DurationSeconds", "documentation":"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.
" }, "Usage":{ "shape":"TrafficUsage", "documentation":"Determines if traffic should be used or ignored while calculating the route.
Default Value: UseTrafficData
Traffic options for the route.
" }, "RouteTrailerOptions":{ "type":"structure", "members":{ "AxleCount":{ "shape":"RouteTrailerOptionsAxleCountInteger", "documentation":"Total number of axles of the vehicle.
" }, "TrailerCount":{ "shape":"RouteTrailerOptionsTrailerCountInteger", "documentation":"Number of trailers attached to the vehicle.
Default Value: 0
Trailer options corresponding to the vehicle.
" }, "RouteTrailerOptionsAxleCountInteger":{ "type":"integer", "box":true, "min":1, "sensitive":true }, "RouteTrailerOptionsTrailerCountInteger":{ "type":"integer", "box":true, "max":255, "min":1, "sensitive":true }, "RouteTransponder":{ "type":"structure", "members":{ "SystemName":{ "shape":"SensitiveString", "documentation":"Names of the toll system collecting the toll.
" } }, "documentation":"Transponders for which this toll can be applied.
" }, "RouteTransponderList":{ "type":"list", "member":{"shape":"RouteTransponder"} }, "RouteTravelMode":{ "type":"string", "enum":[ "Car", "Pedestrian", "Scooter", "Truck" ] }, "RouteTravelModeOptions":{ "type":"structure", "members":{ "Car":{ "shape":"RouteCarOptions", "documentation":"Travel mode options when the provided travel mode is \"Car\"
" }, "Pedestrian":{ "shape":"RoutePedestrianOptions", "documentation":"Travel mode options when the provided travel mode is \"Pedestrian\"
" }, "Scooter":{ "shape":"RouteScooterOptions", "documentation":"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.
Travel mode options when the provided travel mode is \"Truck\"
" } }, "documentation":"Travel mode related options for the provided travel mode.
" }, "RouteTravelStepType":{ "type":"string", "enum":[ "Default", "TurnByTurn" ] }, "RouteTruckOptions":{ "type":"structure", "members":{ "AxleCount":{ "shape":"RouteTruckOptionsAxleCountInteger", "documentation":"Total number of axles of the vehicle.
" }, "EngineType":{ "shape":"RouteEngineType", "documentation":"Engine type of the vehicle.
" }, "GrossWeight":{ "shape":"WeightKilograms", "documentation":"Gross weight of the vehicle including trailers, and goods at capacity.
Unit: Kilograms
List of Hazardous cargo contained in the vehicle.
" }, "Height":{ "shape":"RouteTruckOptionsHeightLong", "documentation":"Height of the vehicle.
Unit: centimeters
Height of the vehicle above its first axle.
Unit: centimeters
Kingpin to rear axle length of the vehicle.
Unit: centimeters
Length of the vehicle.
Unit: c
The vehicle License Plate.
" }, "MaxSpeed":{ "shape":"RouteTruckOptionsMaxSpeedDouble", "documentation":"Maximum speed
Unit: KilometersPerHour
The number of occupants in the vehicle.
Default Value: 1
Payload capacity of the vehicle and trailers attached.
Unit: kilograms
Number of tires on the vehicle.
" }, "Trailer":{ "shape":"RouteTrailerOptions", "documentation":"Trailer options corresponding to the vehicle.
" }, "TruckType":{ "shape":"RouteTruckType", "documentation":"Type of the truck.
" }, "TunnelRestrictionCode":{ "shape":"RouteTruckOptionsTunnelRestrictionCodeString", "documentation":"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
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
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
Width of the vehicle.
Unit: centimeters
Travel mode options when the provided travel mode is \"Truck\"
" }, "RouteTruckOptionsAxleCountInteger":{ "type":"integer", "box":true, "max":255, "min":2, "sensitive":true }, "RouteTruckOptionsHeightAboveFirstAxleLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "RouteTruckOptionsHeightLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "RouteTruckOptionsLengthLong":{ "type":"long", "max":30000, "min":0, "sensitive":true }, "RouteTruckOptionsMaxSpeedDouble":{ "type":"double", "max":252.0, "min":3.6, "sensitive":true }, "RouteTruckOptionsOccupancyInteger":{ "type":"integer", "box":true, "min":1, "sensitive":true }, "RouteTruckOptionsTireCountInteger":{ "type":"integer", "box":true, "max":255, "min":1, "sensitive":true }, "RouteTruckOptionsTunnelRestrictionCodeString":{ "type":"string", "max":20, "min":0, "sensitive":true }, "RouteTruckOptionsWidthLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "RouteTruckType":{ "type":"string", "enum":[ "LightTruck", "StraightTruck", "Tractor" ], "sensitive":true }, "RouteTurnIntensity":{ "type":"string", "enum":[ "Sharp", "Slight", "Typical" ], "sensitive":true }, "RouteTurnStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details related to the turn step.
" }, "RouteUTurnStepDetails":{ "type":"structure", "required":["Intersection"], "members":{ "Intersection":{ "shape":"LocalizedStringList", "documentation":"Name of the intersection, if applicable to the step.
" }, "SteeringDirection":{ "shape":"RouteSteeringDirection", "documentation":"Steering direction for the step.
" }, "TurnAngle":{ "shape":"TurnAngle", "documentation":"Angle of the turn.
" }, "TurnIntensity":{ "shape":"RouteTurnIntensity", "documentation":"Intensity of the turn.
" } }, "documentation":"Details related to the U-turn step.
" }, "RouteVehicleArrival":{ "type":"structure", "required":["Place"], "members":{ "Place":{ "shape":"RouteVehiclePlace", "documentation":"The place details.
" }, "Time":{ "shape":"TimestampWithTimezoneOffset", "documentation":"The time.
" } }, "documentation":"Details corresponding to the arrival for a leg.
" }, "RouteVehicleDeparture":{ "type":"structure", "required":["Place"], "members":{ "Place":{ "shape":"RouteVehiclePlace", "documentation":"The place details.
" }, "Time":{ "shape":"TimestampWithTimezoneOffset", "documentation":"The departure time.
" } }, "documentation":"Details corresponding to the departure for the leg.
" }, "RouteVehicleIncident":{ "type":"structure", "members":{ "Description":{ "shape":"SensitiveString", "documentation":"Brief readable description of the incident.
" }, "EndTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"End timestamp of the incident.
" }, "Severity":{ "shape":"RouteVehicleIncidentSeverity", "documentation":"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
" }, "StartTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"Start time of the incident.
" }, "Type":{ "shape":"RouteVehicleIncidentType", "documentation":"Type of the incident.
" } }, "documentation":"Incidents corresponding to this leg of the route.
" }, "RouteVehicleIncidentList":{ "type":"list", "member":{"shape":"RouteVehicleIncident"} }, "RouteVehicleIncidentSeverity":{ "type":"string", "enum":[ "Critical", "High", "Medium", "Low" ], "sensitive":true }, "RouteVehicleIncidentType":{ "type":"string", "enum":[ "Accident", "Congestion", "Construction", "DisabledVehicle", "LaneRestriction", "MassTransit", "Other", "PlannedEvent", "RoadClosure", "RoadHazard", "Weather" ], "sensitive":true }, "RouteVehicleLegDetails":{ "type":"structure", "required":[ "Arrival", "Departure", "Incidents", "Notices", "PassThroughWaypoints", "Spans", "Tolls", "TollSystems", "TravelSteps", "TruckRoadTypes", "Zones" ], "members":{ "Arrival":{ "shape":"RouteVehicleArrival", "documentation":"Details corresponding to the arrival for the leg.
" }, "Departure":{ "shape":"RouteVehicleDeparture", "documentation":"Details corresponding to the departure for the leg.
" }, "Incidents":{ "shape":"RouteVehicleIncidentList", "documentation":"Incidents corresponding to this leg of the route.
" }, "Notices":{ "shape":"RouteVehicleNoticeList", "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "PassThroughWaypoints":{ "shape":"RoutePassThroughWaypointList", "documentation":"Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
" }, "Spans":{ "shape":"RouteVehicleSpanList", "documentation":"Spans that were computed for the requested SpanAdditionalFeatures.
" }, "Summary":{ "shape":"RouteVehicleSummary", "documentation":"Summarized details of the leg.
" }, "Tolls":{ "shape":"RouteTollList", "documentation":"Toll related options.
" }, "TollSystems":{ "shape":"RouteTollSystemList", "documentation":"Toll systems are authorities that collect payments for the toll.
" }, "TravelSteps":{ "shape":"RouteVehicleTravelStepList", "documentation":"Steps of a leg that must be performed before the travel portion of the leg.
" }, "TruckRoadTypes":{ "shape":"TruckRoadTypeList", "documentation":"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.
" } }, "documentation":"Steps of a leg that correspond to the travel portion of the leg.
" }, "RouteVehicleLicensePlate":{ "type":"structure", "members":{ "LastCharacter":{ "shape":"RouteVehicleLicensePlateLastCharacterString", "documentation":"The last character of the License Plate.
" } }, "documentation":"License plate information of the vehicle. Currently, only the last character is used where license plate based controlled access is enforced.
" }, "RouteVehicleLicensePlateLastCharacterString":{ "type":"string", "max":1, "min":1, "sensitive":true }, "RouteVehicleNotice":{ "type":"structure", "required":[ "Code", "Details" ], "members":{ "Code":{ "shape":"RouteVehicleNoticeCode", "documentation":"Code corresponding to the issue.
" }, "Details":{ "shape":"RouteVehicleNoticeDetailList", "documentation":"Additional details of the notice.
" }, "Impact":{ "shape":"RouteNoticeImpact", "documentation":"Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
" } }, "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "RouteVehicleNoticeCode":{ "type":"string", "enum":[ "AccuratePolylineUnavailable", "Other", "PotentialViolatedAvoidTollRoadUsage", "PotentialViolatedCarpoolUsage", "PotentialViolatedTurnRestrictionUsage", "PotentialViolatedVehicleRestrictionUsage", "PotentialViolatedZoneRestrictionUsage", "SeasonalClosure", "TollsDataTemporarilyUnavailable", "TollsDataUnavailable", "TollTransponder", "ViolatedAvoidControlledAccessHighway", "ViolatedAvoidDifficultTurns", "ViolatedAvoidDirtRoad", "ViolatedAvoidSeasonalClosure", "ViolatedAvoidTollRoad", "ViolatedAvoidTollTransponder", "ViolatedAvoidTruckRoadType", "ViolatedAvoidTunnel", "ViolatedAvoidUTurns", "ViolatedBlockedRoad", "ViolatedCarpool", "ViolatedEmergencyGate", "ViolatedStartDirection", "ViolatedTurnRestriction", "ViolatedVehicleRestriction", "ViolatedZoneRestriction" ] }, "RouteVehicleNoticeDetail":{ "type":"structure", "members":{ "Title":{ "shape":"SensitiveString", "documentation":"The notice title.
" }, "ViolatedConstraints":{ "shape":"RouteViolatedConstraints", "documentation":"Any violated constraints.
" } }, "documentation":"Additional details of the notice.
" }, "RouteVehicleNoticeDetailList":{ "type":"list", "member":{"shape":"RouteVehicleNoticeDetail"} }, "RouteVehicleNoticeList":{ "type":"list", "member":{"shape":"RouteVehicleNotice"} }, "RouteVehicleOverviewSummary":{ "type":"structure", "required":[ "Distance", "Duration" ], "members":{ "BestCaseDuration":{ "shape":"DurationSeconds", "documentation":"Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
Unit: seconds
Distance of the step.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
Unit: seconds
Duration of the computed span under typical traffic congestion.
Unit: seconds
Summarized details of the leg.
" }, "RouteVehiclePlace":{ "type":"structure", "required":["Position"], "members":{ "Name":{ "shape":"SensitiveString", "documentation":"The name of the place.
" }, "OriginalPosition":{ "shape":"Position23", "documentation":"Position provided in the request.
" }, "Position":{ "shape":"Position23", "documentation":"Position defined as [longitude, latitude].
Options to configure matching the provided position to a side of the street.
" }, "WaypointIndex":{ "shape":"RouteVehiclePlaceWaypointIndexInteger", "documentation":"Index of the waypoint in the request.
" } }, "documentation":"Place details corresponding to the arrival or departure.
" }, "RouteVehiclePlaceWaypointIndexInteger":{ "type":"integer", "box":true, "min":0, "sensitive":true }, "RouteVehicleSpan":{ "type":"structure", "members":{ "BestCaseDuration":{ "shape":"DurationSeconds", "documentation":"Duration of the computed span without traffic congestion.
Unit: seconds
Access attributes for a car corresponding to the span.
" }, "Country":{ "shape":"CountryCode3", "documentation":"3 letter Country code corresponding to the Span.
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"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
Dynamic speed details corresponding to the span.
Unit: KilometersPerHour
Functional classification of the road segment corresponding to the span.
" }, "Gate":{ "shape":"RouteSpanGateAttribute", "documentation":"Attributes corresponding to a gate. The gate is present at the end of the returned span.
" }, "GeometryOffset":{ "shape":"RouteVehicleSpanGeometryOffsetInteger", "documentation":"Offset in the leg geometry corresponding to the start of this span.
" }, "Incidents":{ "shape":"IndexList", "documentation":"Incidents corresponding to the span. These index into the Incidents in the parent Leg.
" }, "Names":{ "shape":"LocalizedStringList", "documentation":"Provides an array of names of the vehicle span in available languages.
" }, "Notices":{ "shape":"IndexList", "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "RailwayCrossing":{ "shape":"RouteSpanRailwayCrossingAttribute", "documentation":"Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
" }, "Region":{ "shape":"RouteVehicleSpanRegionString", "documentation":"2-3 letter Region code corresponding to the Span. This is either a province or a state.
" }, "RoadAttributes":{ "shape":"RouteSpanRoadAttributeList", "documentation":"Attributes for the road segment corresponding to the span.
" }, "RouteNumbers":{ "shape":"RouteNumberList", "documentation":"Designated route name or number corresponding to the span.
" }, "ScooterAccess":{ "shape":"RouteSpanScooterAccessAttributeList", "documentation":"Access attributes for a scooter corresponding to the span.
" }, "SpeedLimit":{ "shape":"RouteSpanSpeedLimitDetails", "documentation":"Speed limit details corresponding to the span.
Unit: KilometersPerHour
Toll systems are authorities that collect payments for the toll.
" }, "TruckAccess":{ "shape":"RouteSpanTruckAccessAttributeList", "documentation":"Access attributes for a truck corresponding to the span.
" }, "TruckRoadTypes":{ "shape":"IndexList", "documentation":"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.
Duration of the computed span under typical traffic congestion.
Unit: seconds
Zones corresponding to this leg of the route.
" } }, "documentation":"Span computed for the requested SpanAdditionalFeatures.
" }, "RouteVehicleSpanFunctionalClassificationInteger":{ "type":"integer", "box":true, "max":5, "min":1, "sensitive":true }, "RouteVehicleSpanGeometryOffsetInteger":{ "type":"integer", "box":true, "min":0 }, "RouteVehicleSpanList":{ "type":"list", "member":{"shape":"RouteVehicleSpan"} }, "RouteVehicleSpanRegionString":{ "type":"string", "max":3, "min":0, "sensitive":true }, "RouteVehicleSummary":{ "type":"structure", "members":{ "Overview":{ "shape":"RouteVehicleOverviewSummary", "documentation":"Summarized details for the leg including before travel, travel and after travel steps.
" }, "TravelOnly":{ "shape":"RouteVehicleTravelOnlySummary", "documentation":"Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" } }, "documentation":"Summarized details of the route.
" }, "RouteVehicleTravelOnlySummary":{ "type":"structure", "required":["Duration"], "members":{ "BestCaseDuration":{ "shape":"DurationSeconds", "documentation":"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
Summarized details of the route.
" }, "RouteVehicleTravelStep":{ "type":"structure", "required":[ "Duration", "Type" ], "members":{ "ContinueHighwayStepDetails":{ "shape":"RouteContinueHighwayStepDetails", "documentation":"Details that are specific to a Continue Highway step.
" }, "ContinueStepDetails":{ "shape":"RouteContinueStepDetails", "documentation":"Details that are specific to a Continue step.
" }, "CurrentRoad":{ "shape":"RouteRoad", "documentation":"Details of the current road.
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"Distance of the step.
" }, "Duration":{ "shape":"DurationSeconds", "documentation":"Duration of the step.
Unit: seconds
Details that are specific to a Enter Highway step.
" }, "ExitNumber":{ "shape":"LocalizedStringList", "documentation":"Exit number of the road exit, if applicable.
" }, "ExitStepDetails":{ "shape":"RouteExitStepDetails", "documentation":"Details that are specific to a Roundabout Exit step.
" }, "GeometryOffset":{ "shape":"RouteVehicleTravelStepGeometryOffsetInteger", "documentation":"Offset in the leg geometry corresponding to the start of this step.
" }, "Instruction":{ "shape":"SensitiveString", "documentation":"Brief description of the step in the requested language.
Only available when the TravelStepType is Default.
Details that are specific to a Keep step.
" }, "NextRoad":{ "shape":"RouteRoad", "documentation":"Details of the next road. See RouteRoad for details of sub-attributes.
" }, "RampStepDetails":{ "shape":"RouteRampStepDetails", "documentation":"Details that are specific to a Ramp step.
" }, "RoundaboutEnterStepDetails":{ "shape":"RouteRoundaboutEnterStepDetails", "documentation":"Details that are specific to a Roundabout Enter step.
" }, "RoundaboutExitStepDetails":{ "shape":"RouteRoundaboutExitStepDetails", "documentation":"Details that are specific to a Roundabout Exit step.
" }, "RoundaboutPassStepDetails":{ "shape":"RouteRoundaboutPassStepDetails", "documentation":"Details that are specific to a Roundabout Pass step.
" }, "Signpost":{ "shape":"RouteSignpost", "documentation":"Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
" }, "TurnStepDetails":{ "shape":"RouteTurnStepDetails", "documentation":"Details that are specific to a Turn step.
" }, "Type":{ "shape":"RouteVehicleTravelStepType", "documentation":"Type of the step.
" }, "UTurnStepDetails":{ "shape":"RouteUTurnStepDetails", "documentation":"Details that are specific to a Turn step.
" } }, "documentation":"Steps of a leg that correspond to the travel portion of the leg.
" }, "RouteVehicleTravelStepGeometryOffsetInteger":{ "type":"integer", "box":true, "min":0 }, "RouteVehicleTravelStepList":{ "type":"list", "member":{"shape":"RouteVehicleTravelStep"} }, "RouteVehicleTravelStepType":{ "type":"string", "enum":[ "Arrive", "Continue", "ContinueHighway", "Depart", "EnterHighway", "Exit", "Keep", "Ramp", "RoundaboutEnter", "RoundaboutExit", "RoundaboutPass", "Turn", "UTurn" ], "sensitive":true }, "RouteViolatedConstraints":{ "type":"structure", "required":["HazardousCargos"], "members":{ "AllHazardsRestricted":{ "shape":"SensitiveBoolean", "documentation":"This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.
" }, "AxleCount":{ "shape":"RouteNoticeDetailRange", "documentation":"Total number of axles of the vehicle.
" }, "HazardousCargos":{ "shape":"RouteHazardousCargoTypeList", "documentation":"List of Hazardous cargo contained in the vehicle.
" }, "MaxHeight":{ "shape":"DimensionCentimeters", "documentation":"The maximum height of the vehicle.
" }, "MaxKpraLength":{ "shape":"DimensionCentimeters", "documentation":"The maximum Kpra length of the vehicle.
Unit: centimeters
The maximum length of the vehicle.
" }, "MaxPayloadCapacity":{ "shape":"WeightKilograms", "documentation":"The maximum load capacity of the vehicle.
Unit: kilograms
The maximum weight of the route.
Unit: Kilograms
The maximum weight per axle of the vehicle.
Unit: Kilograms
The maximum weight per axle group of the vehicle.
Unit: Kilograms
The maximum width of the vehicle.
" }, "Occupancy":{ "shape":"RouteNoticeDetailRange", "documentation":"The number of occupants in the vehicle.
Default Value: 1
Access radius restrictions based on time.
" }, "TimeDependent":{ "shape":"SensitiveBoolean", "documentation":"The time dependent constraint.
" }, "TrailerCount":{ "shape":"RouteNoticeDetailRange", "documentation":"Number of trailers attached to the vehicle.
Default Value: 0
Travel mode corresponding to the leg.
" }, "TruckRoadType":{ "shape":"String", "documentation":"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.
Type of the truck.
" }, "TunnelRestrictionCode":{ "shape":"TunnelRestrictionCode", "documentation":"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
This property contains a summary of violated constraints.
" }, "RouteWaypoint":{ "type":"structure", "required":["Position"], "members":{ "AvoidActionsForDistance":{ "shape":"RouteWaypointAvoidActionsForDistanceLong", "documentation":"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.
" }, "AvoidUTurns":{ "shape":"SensitiveBoolean", "documentation":"Avoid U-turns for calculation on highways and motorways.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Matching":{ "shape":"RouteMatchingOptions", "documentation":"Options to configure matching the provided position to the road network.
" }, "PassThrough":{ "shape":"SensitiveBoolean", "documentation":"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.
" }, "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
Options to configure matching the provided position to a side of the street.
" }, "StopDuration":{ "shape":"DurationSeconds", "documentation":"Duration of the stop.
Unit: seconds
Waypoint between the Origin and Destination.
" }, "RouteWaypointAvoidActionsForDistanceLong":{ "type":"long", "max":2000, "sensitive":true }, "RouteWaypointList":{ "type":"list", "member":{"shape":"RouteWaypoint"} }, "RouteWeightConstraint":{ "type":"structure", "required":[ "Type", "Value" ], "members":{ "Type":{ "shape":"RouteWeightConstraintType", "documentation":"The type of constraint.
" }, "Value":{ "shape":"WeightKilograms", "documentation":"The constraint value.
Unit: Kilograms
The weight constraint for the route.
Unit: Kilograms
The zone category.
" }, "Name":{ "shape":"SensitiveString", "documentation":"The name of the zone.
" } }, "documentation":"The zone.
" }, "RouteZoneCategory":{ "type":"string", "enum":[ "CongestionPricing", "Environmental", "Vignette" ], "sensitive":true }, "RouteZoneList":{ "type":"list", "member":{"shape":"RouteZone"} }, "RoutingObjective":{ "type":"string", "enum":[ "FastestRoute", "ShortestRoute" ] }, "SensitiveBoolean":{ "type":"boolean", "box":true, "sensitive":true }, "SensitiveDouble":{ "type":"double", "box":true, "sensitive":true }, "SensitiveString":{ "type":"string", "sensitive":true }, "SideOfStreetMatchingStrategy":{ "type":"string", "enum":[ "AnyStreet", "DividedStreetOnly" ] }, "SnapToRoadsRequest":{ "type":"structure", "required":["TracePoints"], "members":{ "Key":{ "shape":"ApiKey", "documentation":"Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" }, "SnappedGeometryFormat":{ "shape":"GeometryFormat", "documentation":"Chooses what the returned SnappedGeometry format should be.
Default Value: FlexiblePolyline
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.
" }, "TravelMode":{ "shape":"RoadSnapTravelMode", "documentation":"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.
" } } }, "SnapToRoadsRequestSnapRadiusLong":{ "type":"long", "max":10000, "min":0, "sensitive":true }, "SnapToRoadsRequestTracePointsList":{ "type":"list", "member":{"shape":"RoadSnapTracePoint"}, "max":5000, "min":2 }, "SnapToRoadsResponse":{ "type":"structure", "required":[ "Notices", "PricingBucket", "SnappedGeometryFormat", "SnappedTracePoints" ], "members":{ "Notices":{ "shape":"RoadSnapNoticeList", "documentation":"Notices are additional information returned that indicate issues that occurred during route calculation.
" }, "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "SnappedGeometry":{ "shape":"RoadSnapSnappedGeometry", "documentation":"The interpolated geometry for the snapped route onto the road network.
" }, "SnappedGeometryFormat":{ "shape":"GeometryFormat", "documentation":"Specifies the format of the geometry returned for each leg of the route.
" }, "SnappedTracePoints":{ "shape":"RoadSnapSnappedTracePointList", "documentation":"The trace points snapped onto the road network.
" } } }, "SpeedKilometersPerHour":{ "type":"double", "min":0.0, "sensitive":true }, "String":{"type":"string"}, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "TimeOfDay":{ "type":"string", "pattern":"([0-1]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](Z|[+-]([0-1]?[0-9]|2[0-3]):[0-5][0-9])", "sensitive":true }, "TimeThresholdList":{ "type":"list", "member":{"shape":"TimeThresholdListMemberLong"}, "max":5, "min":1 }, "TimeThresholdListMemberLong":{ "type":"long", "max":10800, "min":0, "sensitive":true }, "TimestampWithTimezoneOffset":{ "type":"string", "pattern":"([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])", "sensitive":true }, "TrafficUsage":{ "type":"string", "enum":[ "IgnoreTrafficData", "UseTrafficData" ] }, "TruckRoadType":{ "type":"string", "max":3, "min":1, "sensitive":true }, "TruckRoadTypeList":{ "type":"list", "member":{"shape":"TruckRoadType"}, "max":12, "min":1 }, "TunnelRestrictionCode":{ "type":"string", "max":1, "min":1, "sensitive":true }, "TurnAngle":{ "type":"double", "max":180, "min":-180 }, "ValidationException":{ "type":"structure", "required":[ "Message", "Reason", "FieldList" ], "members":{ "Message":{ "shape":"String", "locationName":"message" }, "Reason":{ "shape":"ValidationExceptionReason", "documentation":"A message with the reason for the validation exception error.
", "locationName":"reason" }, "FieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"The field where the invalid entry was detected.
", "locationName":"fieldList" } }, "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "Name", "Message" ], "members":{ "Name":{ "shape":"String", "documentation":"The name of the Validation Exception Field.
", "locationName":"name" }, "Message":{ "shape":"String", "documentation":"The error message.
", "locationName":"message" } }, "documentation":"The input fails to satisfy the constraints specified by the Amazon Location service.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "UnknownOperation", "Missing", "CannotParse", "FieldValidationFailed", "Other", "UnknownField" ] }, "WaypointId":{ "type":"string", "max":100, "min":1 }, "WaypointIndex":{"type":"integer"}, "WaypointOptimizationAccessHours":{ "type":"structure", "required":[ "From", "To" ], "members":{ "From":{ "shape":"WaypointOptimizationAccessHoursEntry", "documentation":"Contains the ID of the starting waypoint in this connection.
" }, "To":{ "shape":"WaypointOptimizationAccessHoursEntry", "documentation":"Contains the ID of the ending waypoint in this connection.
" } }, "documentation":"Access hours corresponding to when a destination can be visited.
" }, "WaypointOptimizationAccessHoursEntry":{ "type":"structure", "required":[ "DayOfWeek", "TimeOfDay" ], "members":{ "DayOfWeek":{ "shape":"DayOfWeek", "documentation":"Day of the week.
" }, "TimeOfDay":{ "shape":"TimeOfDay", "documentation":"Time of the day.
" } }, "documentation":"Hours of entry.
" }, "WaypointOptimizationAvoidanceArea":{ "type":"structure", "required":["Geometry"], "members":{ "Geometry":{ "shape":"WaypointOptimizationAvoidanceAreaGeometry", "documentation":"Geometry of the area to be avoided.
" } }, "documentation":"The area to be avoided.
" }, "WaypointOptimizationAvoidanceAreaGeometry":{ "type":"structure", "members":{ "BoundingBox":{ "shape":"BoundingBox", "documentation":"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.
" } }, "documentation":"Geometry of the area to be avoided.
" }, "WaypointOptimizationAvoidanceOptions":{ "type":"structure", "members":{ "Areas":{ "shape":"WaypointOptimizationAvoidanceOptionsAreasList", "documentation":"Areas to be avoided.
" }, "CarShuttleTrains":{ "shape":"SensitiveBoolean", "documentation":"Avoidance options for cars-shuttles-trains.
" }, "ControlledAccessHighways":{ "shape":"SensitiveBoolean", "documentation":"Avoid controlled access highways while calculating the route.
" }, "DirtRoads":{ "shape":"SensitiveBoolean", "documentation":"Avoid dirt roads while calculating the route.
" }, "Ferries":{ "shape":"SensitiveBoolean", "documentation":"Avoidance options for ferries.
" }, "TollRoads":{ "shape":"SensitiveBoolean", "documentation":"Avoids roads where the specified toll transponders are the only mode of payment.
" }, "Tunnels":{ "shape":"SensitiveBoolean", "documentation":"Avoid tunnels while calculating the route.
" }, "UTurns":{ "shape":"SensitiveBoolean", "documentation":"Avoid U-turns for calculation on highways and motorways.
" } }, "documentation":"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.
" }, "WaypointOptimizationAvoidanceOptionsAreasList":{ "type":"list", "member":{"shape":"WaypointOptimizationAvoidanceArea"}, "max":20, "min":0 }, "WaypointOptimizationClusteringAlgorithm":{ "type":"string", "enum":[ "DrivingDistance", "TopologySegment" ], "sensitive":true }, "WaypointOptimizationClusteringOptions":{ "type":"structure", "required":["Algorithm"], "members":{ "Algorithm":{ "shape":"WaypointOptimizationClusteringAlgorithm", "documentation":"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.
Driving distance options to be used when the clustering algorithm is DrivingDistance.
" } }, "documentation":"Options for WaypointOptimizationClustering.
" }, "WaypointOptimizationConnection":{ "type":"structure", "required":[ "Distance", "From", "RestDuration", "To", "TravelDuration", "WaitDuration" ], "members":{ "Distance":{ "shape":"DistanceMeters", "documentation":"Distance of the step.
" }, "From":{ "shape":"WaypointId", "documentation":"contains the ID of the starting waypoint in this connection.
" }, "RestDuration":{ "shape":"DurationSeconds", "documentation":"Resting time before the driver can continue driving.
" }, "To":{ "shape":"WaypointId", "documentation":"Contains the ID of the ending waypoint in this connection.
" }, "TravelDuration":{ "shape":"DurationSeconds", "documentation":"Total duration.
Unit: seconds
Duration of a wait step.
Unit: seconds
This contains information such as distance and duration from one waypoint to the next waypoint in the sequence.
" }, "WaypointOptimizationConnectionList":{ "type":"list", "member":{"shape":"WaypointOptimizationConnection"} }, "WaypointOptimizationConstraint":{ "type":"string", "enum":[ "AccessHours", "AppointmentTime", "Before", "Heading", "ServiceDuration", "SideOfStreet" ], "sensitive":true }, "WaypointOptimizationDestinationOptions":{ "type":"structure", "members":{ "AccessHours":{ "shape":"WaypointOptimizationAccessHours", "documentation":"Access hours corresponding to when a waypoint can be visited.
" }, "AppointmentTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"Appointment time at the destination.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Id":{ "shape":"WaypointId", "documentation":"The waypoint Id.
" }, "ServiceDuration":{ "shape":"DurationSeconds", "documentation":"Service time spent at the destination. At an appointment, the service time should be the appointment duration.
Unit: seconds
Options to configure matching the provided position to a side of the street.
" } }, "documentation":"Destination related options.
" }, "WaypointOptimizationDriverOptions":{ "type":"structure", "members":{ "RestCycles":{ "shape":"WaypointOptimizationRestCycles", "documentation":"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.
" }, "RestProfile":{ "shape":"WaypointOptimizationRestProfile", "documentation":"Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.
" }, "TreatServiceTimeAs":{ "shape":"WaypointOptimizationServiceTimeTreatment", "documentation":"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.
" } }, "documentation":"Driver related options.
" }, "WaypointOptimizationDrivingDistanceOptions":{ "type":"structure", "required":["DrivingDistance"], "members":{ "DrivingDistance":{ "shape":"DistanceMeters", "documentation":"DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster.
" } }, "documentation":"Driving distance related options.
" }, "WaypointOptimizationExclusionOptions":{ "type":"structure", "required":["Countries"], "members":{ "Countries":{ "shape":"CountryCodeList", "documentation":"List of countries to be avoided defined by two-letter or three-letter country codes.
" } }, "documentation":"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.
" }, "WaypointOptimizationFailedConstraint":{ "type":"structure", "members":{ "Constraint":{ "shape":"WaypointOptimizationConstraint", "documentation":"The failed constraint.
" }, "Reason":{ "shape":"SensitiveString", "documentation":"Reason for the failed constraint.
" } }, "documentation":"The failed constraint.
" }, "WaypointOptimizationFailedConstraintList":{ "type":"list", "member":{"shape":"WaypointOptimizationFailedConstraint"} }, "WaypointOptimizationHazardousCargoType":{ "type":"string", "enum":[ "Combustible", "Corrosive", "Explosive", "Flammable", "Gas", "HarmfulToWater", "Organic", "Other", "Poison", "PoisonousInhalation", "Radioactive" ], "sensitive":true }, "WaypointOptimizationHazardousCargoTypeList":{ "type":"list", "member":{"shape":"WaypointOptimizationHazardousCargoType"} }, "WaypointOptimizationImpedingWaypoint":{ "type":"structure", "required":[ "FailedConstraints", "Id", "Position" ], "members":{ "FailedConstraints":{ "shape":"WaypointOptimizationFailedConstraintList", "documentation":"Failed constraints for an impeding waypoint.
" }, "Id":{ "shape":"WaypointId", "documentation":"The waypoint Id.
" }, "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
The impeding waypoint.
" }, "WaypointOptimizationImpedingWaypointList":{ "type":"list", "member":{"shape":"WaypointOptimizationImpedingWaypoint"} }, "WaypointOptimizationOptimizedWaypoint":{ "type":"structure", "required":[ "DepartureTime", "Id", "Position" ], "members":{ "ArrivalTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"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
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.
" }, "DepartureTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"Estimated time of departure from thr 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
The waypoint Id.
" }, "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
The optimized waypoint.
" }, "WaypointOptimizationOptimizedWaypointList":{ "type":"list", "member":{"shape":"WaypointOptimizationOptimizedWaypoint"} }, "WaypointOptimizationOriginOptions":{ "type":"structure", "members":{ "Id":{ "shape":"WaypointId", "documentation":"The Origin Id.
" } }, "documentation":"Origin related options.
" }, "WaypointOptimizationPedestrianOptions":{ "type":"structure", "members":{ "Speed":{ "shape":"WaypointOptimizationPedestrianOptionsSpeedDouble", "documentation":"Walking speed.
Unit: KilometersPerHour
Options related to a pedestrian.
" }, "WaypointOptimizationPedestrianOptionsSpeedDouble":{ "type":"double", "max":7.2, "min":1.8, "sensitive":true }, "WaypointOptimizationRestCycleDurations":{ "type":"structure", "required":[ "RestDuration", "WorkDuration" ], "members":{ "RestDuration":{ "shape":"DurationSeconds", "documentation":"Resting phase of the cycle.
Unit: seconds
Working phase of the cycle.
Unit: seconds
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.
" }, "ShortCycle":{ "shape":"WaypointOptimizationRestCycleDurations", "documentation":"Short cycle for a driver work-rest schedule
" } }, "documentation":"Resting phase of the cycle.
" }, "WaypointOptimizationRestProfile":{ "type":"structure", "required":["Profile"], "members":{ "Profile":{ "shape":"WaypointOptimizationRestProfileProfileString", "documentation":"Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.
" } }, "documentation":"Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.
" }, "WaypointOptimizationRestProfileProfileString":{ "type":"string", "max":2, "min":2, "sensitive":true }, "WaypointOptimizationSequencingObjective":{ "type":"string", "enum":[ "FastestRoute", "ShortestRoute" ] }, "WaypointOptimizationServiceTimeTreatment":{ "type":"string", "enum":[ "Rest", "Work" ], "sensitive":true }, "WaypointOptimizationSideOfStreetOptions":{ "type":"structure", "required":["Position"], "members":{ "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
Default Value: DividedStreetOnly
Options to configure matching the provided position to a side of the street.
" }, "WaypointOptimizationTimeBreakdown":{ "type":"structure", "required":[ "RestDuration", "ServiceDuration", "TravelDuration", "WaitDuration" ], "members":{ "RestDuration":{ "shape":"DurationSeconds", "documentation":"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
Time breakdown for the sequence.
" }, "WaypointOptimizationTrafficOptions":{ "type":"structure", "members":{ "Usage":{ "shape":"TrafficUsage", "documentation":"Determines if traffic should be used or ignored while calculating the route.
Default Value: UseTrafficData
Options related to traffic.
" }, "WaypointOptimizationTrailerOptions":{ "type":"structure", "members":{ "TrailerCount":{ "shape":"WaypointOptimizationTrailerOptionsTrailerCountInteger", "documentation":"Number of trailers attached to the vehicle.
Default Value: 0
Trailer options corresponding to the vehicle.
" }, "WaypointOptimizationTrailerOptionsTrailerCountInteger":{ "type":"integer", "box":true, "max":255, "min":0, "sensitive":true }, "WaypointOptimizationTravelMode":{ "type":"string", "enum":[ "Car", "Pedestrian", "Scooter", "Truck" ] }, "WaypointOptimizationTravelModeOptions":{ "type":"structure", "members":{ "Pedestrian":{ "shape":"WaypointOptimizationPedestrianOptions", "documentation":"Travel mode options when the provided travel mode is \"Pedestrian\"
" }, "Truck":{ "shape":"WaypointOptimizationTruckOptions", "documentation":"Travel mode options when the provided travel mode is \"Truck\"
" } }, "documentation":"Travel mode related options for the provided travel mode.
" }, "WaypointOptimizationTruckOptions":{ "type":"structure", "members":{ "GrossWeight":{ "shape":"WeightKilograms", "documentation":"Gross weight of the vehicle including trailers, and goods at capacity.
Unit: Kilograms
List of Hazardous cargo contained in the vehicle.
" }, "Height":{ "shape":"WaypointOptimizationTruckOptionsHeightLong", "documentation":"Height of the vehicle.
Unit: centimeters
Length of the vehicle.
Unit: centimeters
Trailer options corresponding to the vehicle.
" }, "TruckType":{ "shape":"WaypointOptimizationTruckType", "documentation":"Type of the truck.
" }, "TunnelRestrictionCode":{ "shape":"TunnelRestrictionCode", "documentation":"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
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
Width of the vehicle.
Unit: centimeters
Travel mode options when the provided travel mode is \"Truck\"
" }, "WaypointOptimizationTruckOptionsHeightLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "WaypointOptimizationTruckOptionsLengthLong":{ "type":"long", "max":30000, "min":0, "sensitive":true }, "WaypointOptimizationTruckOptionsWidthLong":{ "type":"long", "max":5000, "min":0, "sensitive":true }, "WaypointOptimizationTruckType":{ "type":"string", "enum":[ "StraightTruck", "Tractor" ], "sensitive":true }, "WaypointOptimizationWaypoint":{ "type":"structure", "required":["Position"], "members":{ "AccessHours":{ "shape":"WaypointOptimizationAccessHours", "documentation":"Access hours corresponding to when a waypoint can be visited.
" }, "AppointmentTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"Appointment time at the waypoint.
" }, "Before":{ "shape":"BeforeWaypointsList", "documentation":"Constraint defining what waypoints are to be visited after this waypoint.
" }, "Heading":{ "shape":"Heading", "documentation":"GPS Heading at the position.
" }, "Id":{ "shape":"WaypointId", "documentation":"The waypoint Id.
" }, "Position":{ "shape":"Position", "documentation":"Position defined as [longitude, latitude].
Service time spent at the waypoint. At an appointment, the service time should be the appointment duration.
Unit: seconds
Options to configure matching the provided position to a side of the street.
" } }, "documentation":"Waypoint between the Origin and Destination.
" }, "WaypointOptimizationWaypointList":{ "type":"list", "member":{"shape":"WaypointOptimizationWaypoint"} }, "WeightKilograms":{ "type":"long", "max":4294967295, "min":0, "sensitive":true }, "WeightPerAxleGroup":{ "type":"structure", "members":{ "Single":{ "shape":"WeightKilograms", "documentation":"Weight for single axle group.
Unit: Kilograms
Weight for tandem axle group.
Unit: Kilograms
Weight for triple axle group.
Unit: Kilograms
Weight for quad axle group.
Unit: Kilograms
Weight for quad quint group.
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.
Unit: Kilograms
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