RouteVehicleSpan
Span computed for the requested SpanAdditionalFeatures.
Contents
- BestCaseDuration
-
Duration of the computed span without traffic congestion.
Unit:
seconds
Type: Long
Valid Range: Minimum value of 0. Maximum value of 4294967295.
Required: No
- CarAccess
-
Access attributes for a car corresponding to the span.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Valid Values:
Allowed | NoThroughTraffic | TollRoad
Required: No
- Country
-
3 letter Country code corresponding to the Span.
Type: String
Length Constraints: Fixed length of 3.
Pattern:
[A-Z]{3}
Required: No
- Distance
-
Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 4294967295.
Required: No
- Duration
-
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
Type: Long
Valid Range: Minimum value of 0. Maximum value of 4294967295.
Required: No
- DynamicSpeed
-
Dynamic speed details corresponding to the span.
Unit:
KilometersPerHour
Type: RouteSpanDynamicSpeedDetails object
Required: No
- FunctionalClassification
-
Functional classification of the road segment corresponding to the span.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 5.
Required: No
- Gate
-
Attributes corresponding to a gate. The gate is present at the end of the returned span.
Type: String
Valid Values:
Emergency | KeyAccess | PermissionRequired
Required: No
- GeometryOffset
-
Offset in the leg geometry corresponding to the start of this span.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- Incidents
-
Incidents corresponding to the span. These index into the Incidents in the parent Leg.
Type: Array of integers
Required: No
- Names
-
Provides an array of names of the vehicle span in available languages.
Type: Array of LocalizedString objects
Required: No
- Notices
-
Notices are additional information returned that indicate issues that occurred during route calculation.
Type: Array of integers
Required: No
- RailwayCrossing
-
Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
Type: String
Valid Values:
Protected | Unprotected
Required: No
- Region
-
2-3 letter Region code corresponding to the Span. This is either a province or a state.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 3.
Required: No
- RoadAttributes
-
Attributes for the road segment corresponding to the span.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 12 items.
Valid Values:
Bridge | BuiltUpArea | ControlledAccessHighway | DirtRoad | DividedRoad | Motorway | PrivateRoad | Ramp | RightHandTraffic | Roundabout | Tunnel | UnderConstruction
Required: No
- RouteNumbers
-
Designated route name or number corresponding to the span.
Type: Array of RouteNumber objects
Required: No
- ScooterAccess
-
Access attributes for a scooter corresponding to the span.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Valid Values:
Allowed | NoThroughTraffic | TollRoad
Required: No
- SpeedLimit
-
Speed limit details corresponding to the span.
Unit:
KilometersPerHour
Type: RouteSpanSpeedLimitDetails object
Required: No
- TollSystems
-
Toll systems are authorities that collect payments for the toll.
Type: Array of integers
Required: No
- TruckAccess
-
Access attributes for a truck corresponding to the span.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Valid Values:
Allowed | NoThroughTraffic | TollRoad
Required: No
- TruckRoadTypes
-
Truck road type identifiers.
BK1
throughBK4
apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4
apply only to Mexico.Note
There are currently no other supported values as of 26th April 2024.
Type: Array of integers
Required: No
- TypicalDuration
-
Duration of the computed span under typical traffic congestion.
Unit:
seconds
Type: Long
Valid Range: Minimum value of 0. Maximum value of 4294967295.
Required: No
- Zones
-
Zones corresponding to this leg of the route.
Type: Array of integers
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: