RouteTrafficOptions
Traffic options for the route.
Contents
- FlowEventThresholdOverride
-
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.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 4294967295.
Required: No
- Usage
-
Specifies how traffic data should be used when calculating routes.
Default Value:
UseTrafficDataNote
Traffic data usage depends on the time parameters in your route request:
-
When
Usageis set toUseTrafficData:-
If
DepartNowis set totrue, or if you specifyDepartureTimeorArrivalTime, then all traffic data is considered (including live traffic and closures). -
If
DepartNow,DepartureTime, andArrivalTimeare all unspecified, then only long-term closures are considered, regardless of this setting.
-
-
When
Usageis set toIgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.
Type: String
Valid Values:
IgnoreTrafficData | UseTrafficDataRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
