| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Location.CalculateRouteMatrix
Description
Calculates a route matrix
given the following required parameters: DeparturePositions and
DestinationPositions. CalculateRouteMatrix calculates routes and
returns the travel time and travel distance from each departure position
to each destination position in the request. For example, given
departure positions A and B, and destination positions X and Y,
CalculateRouteMatrix will return time and distance for routes from A
to X, A to Y, B to X, and B to Y (in that order). The number of results
returned (and routes calculated) will be the number of
DeparturePositions times the number of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.
Additional options include:
Specifying a departure time using either
DepartureTimeorDepartNow. This calculates routes based on predictive traffic data at the given time.You can't specify both
DepartureTimeandDepartNowin a single request. Specifying both parameters returns a validation error.- Specifying a travel mode
using TravelMode sets the transportation mode used to calculate the
routes. This also lets you specify additional route preferences in
CarModeOptionsif traveling byCar, orTruckModeOptionsif traveling byTruck.
Synopsis
- data CalculateRouteMatrix = CalculateRouteMatrix' {
- carModeOptions :: Maybe CalculateRouteCarModeOptions
- departNow :: Maybe Bool
- departureTime :: Maybe ISO8601
- distanceUnit :: Maybe DistanceUnit
- travelMode :: Maybe TravelMode
- truckModeOptions :: Maybe CalculateRouteTruckModeOptions
- calculatorName :: Text
- departurePositions :: NonEmpty (Sensitive (NonEmpty Double))
- destinationPositions :: NonEmpty (Sensitive (NonEmpty Double))
- newCalculateRouteMatrix :: Text -> NonEmpty (NonEmpty Double) -> NonEmpty (NonEmpty Double) -> CalculateRouteMatrix
- calculateRouteMatrix_carModeOptions :: Lens' CalculateRouteMatrix (Maybe CalculateRouteCarModeOptions)
- calculateRouteMatrix_departNow :: Lens' CalculateRouteMatrix (Maybe Bool)
- calculateRouteMatrix_departureTime :: Lens' CalculateRouteMatrix (Maybe UTCTime)
- calculateRouteMatrix_distanceUnit :: Lens' CalculateRouteMatrix (Maybe DistanceUnit)
- calculateRouteMatrix_travelMode :: Lens' CalculateRouteMatrix (Maybe TravelMode)
- calculateRouteMatrix_truckModeOptions :: Lens' CalculateRouteMatrix (Maybe CalculateRouteTruckModeOptions)
- calculateRouteMatrix_calculatorName :: Lens' CalculateRouteMatrix Text
- calculateRouteMatrix_departurePositions :: Lens' CalculateRouteMatrix (NonEmpty (NonEmpty Double))
- calculateRouteMatrix_destinationPositions :: Lens' CalculateRouteMatrix (NonEmpty (NonEmpty Double))
- data CalculateRouteMatrixResponse = CalculateRouteMatrixResponse' {}
- newCalculateRouteMatrixResponse :: Int -> CalculateRouteMatrixSummary -> CalculateRouteMatrixResponse
- calculateRouteMatrixResponse_snappedDeparturePositions :: Lens' CalculateRouteMatrixResponse (Maybe (NonEmpty (NonEmpty Double)))
- calculateRouteMatrixResponse_snappedDestinationPositions :: Lens' CalculateRouteMatrixResponse (Maybe (NonEmpty (NonEmpty Double)))
- calculateRouteMatrixResponse_httpStatus :: Lens' CalculateRouteMatrixResponse Int
- calculateRouteMatrixResponse_routeMatrix :: Lens' CalculateRouteMatrixResponse [[RouteMatrixEntry]]
- calculateRouteMatrixResponse_summary :: Lens' CalculateRouteMatrixResponse CalculateRouteMatrixSummary
Creating a Request
data CalculateRouteMatrix Source #
See: newCalculateRouteMatrix smart constructor.
Constructors
| CalculateRouteMatrix' | |
Fields
| |
Instances
newCalculateRouteMatrix Source #
Create a value of CalculateRouteMatrix with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:carModeOptions:CalculateRouteMatrix', calculateRouteMatrix_carModeOptions - Specifies route preferences when traveling by Car, such as avoiding
routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car.
$sel:departNow:CalculateRouteMatrix', calculateRouteMatrix_departNow - Sets the time of departure as the current time. Uses the current time to
calculate the route matrix. You can't set both DepartureTime and
DepartNow. If neither is set, the best time of day to travel with the
best traffic conditions is used to calculate the route matrix.
Default Value: false
Valid Values: false | true
$sel:departureTime:CalculateRouteMatrix', calculateRouteMatrix_departureTime - Specifies the desired time of departure. Uses the given time to
calculate the route matrix. You can't set both DepartureTime and
DepartNow. If neither is set, the best time of day to travel with the
best traffic conditions is used to calculate the route matrix.
Setting a departure time in the past returns a 400 ValidationException
error.
- In ISO 8601
format:
YYYY-MM-DDThh:mm:ss.sssZ. For example,2020–07-2T12:15:20.000Z+01:00
CalculateRouteMatrix, calculateRouteMatrix_distanceUnit - Set the unit system to specify the distance.
Default Value: Kilometers
$sel:travelMode:CalculateRouteMatrix', calculateRouteMatrix_travelMode - Specifies the mode of transport when calculating a route. Used in
estimating the speed of travel and road compatibility.
The TravelMode you specify also determines how you specify route
preferences:
- If traveling by
Caruse theCarModeOptionsparameter. - If traveling by
Truckuse theTruckModeOptionsparameter.
Default Value: Car
$sel:truckModeOptions:CalculateRouteMatrix', calculateRouteMatrix_truckModeOptions - Specifies route preferences when traveling by Truck, such as avoiding
routes that use ferries or tolls, and truck specifications to consider
when choosing an optimal road.
Requirements: TravelMode must be specified as Truck.
CalculateRouteMatrix, calculateRouteMatrix_calculatorName - The name of the route calculator resource that you want to use to
calculate the route matrix.
$sel:departurePositions:CalculateRouteMatrix', calculateRouteMatrix_departurePositions - The list of departure (origin) positions for the route matrix. An array
of points, each of which is itself a 2-value array defined in
WGS 84 format:
[longitude, latitude]. For example, [-123.115, 49.285].
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify
a departure that's not located on a road, Amazon Location
moves the position to the nearest road.
The snapped value is available in the result in
SnappedDeparturePositions.
Valid Values: [-180 to 180,-90 to 90]
$sel:destinationPositions:CalculateRouteMatrix', calculateRouteMatrix_destinationPositions - The list of destination positions for the route matrix. An array of
points, each of which is itself a 2-value array defined in
WGS 84 format:
[longitude, latitude]. For example, [-122.339, 47.615]
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify
a destination that's not located on a road, Amazon Location
moves the position to the nearest road.
The snapped value is available in the result in
SnappedDestinationPositions.
Valid Values: [-180 to 180,-90 to 90]
Request Lenses
calculateRouteMatrix_carModeOptions :: Lens' CalculateRouteMatrix (Maybe CalculateRouteCarModeOptions) Source #
Specifies route preferences when traveling by Car, such as avoiding
routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car.
calculateRouteMatrix_departNow :: Lens' CalculateRouteMatrix (Maybe Bool) Source #
Sets the time of departure as the current time. Uses the current time to
calculate the route matrix. You can't set both DepartureTime and
DepartNow. If neither is set, the best time of day to travel with the
best traffic conditions is used to calculate the route matrix.
Default Value: false
Valid Values: false | true
calculateRouteMatrix_departureTime :: Lens' CalculateRouteMatrix (Maybe UTCTime) Source #
Specifies the desired time of departure. Uses the given time to
calculate the route matrix. You can't set both DepartureTime and
DepartNow. If neither is set, the best time of day to travel with the
best traffic conditions is used to calculate the route matrix.
Setting a departure time in the past returns a 400 ValidationException
error.
- In ISO 8601
format:
YYYY-MM-DDThh:mm:ss.sssZ. For example,2020–07-2T12:15:20.000Z+01:00
calculateRouteMatrix_distanceUnit :: Lens' CalculateRouteMatrix (Maybe DistanceUnit) Source #
Set the unit system to specify the distance.
Default Value: Kilometers
calculateRouteMatrix_travelMode :: Lens' CalculateRouteMatrix (Maybe TravelMode) Source #
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The TravelMode you specify also determines how you specify route
preferences:
- If traveling by
Caruse theCarModeOptionsparameter. - If traveling by
Truckuse theTruckModeOptionsparameter.
Default Value: Car
calculateRouteMatrix_truckModeOptions :: Lens' CalculateRouteMatrix (Maybe CalculateRouteTruckModeOptions) Source #
Specifies route preferences when traveling by Truck, such as avoiding
routes that use ferries or tolls, and truck specifications to consider
when choosing an optimal road.
Requirements: TravelMode must be specified as Truck.
calculateRouteMatrix_calculatorName :: Lens' CalculateRouteMatrix Text Source #
The name of the route calculator resource that you want to use to calculate the route matrix.
calculateRouteMatrix_departurePositions :: Lens' CalculateRouteMatrix (NonEmpty (NonEmpty Double)) Source #
The list of departure (origin) positions for the route matrix. An array
of points, each of which is itself a 2-value array defined in
WGS 84 format:
[longitude, latitude]. For example, [-123.115, 49.285].
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify
a departure that's not located on a road, Amazon Location
moves the position to the nearest road.
The snapped value is available in the result in
SnappedDeparturePositions.
Valid Values: [-180 to 180,-90 to 90]
calculateRouteMatrix_destinationPositions :: Lens' CalculateRouteMatrix (NonEmpty (NonEmpty Double)) Source #
The list of destination positions for the route matrix. An array of
points, each of which is itself a 2-value array defined in
WGS 84 format:
[longitude, latitude]. For example, [-122.339, 47.615]
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify
a destination that's not located on a road, Amazon Location
moves the position to the nearest road.
The snapped value is available in the result in
SnappedDestinationPositions.
Valid Values: [-180 to 180,-90 to 90]
Destructuring the Response
data CalculateRouteMatrixResponse Source #
Returns the result of the route matrix calculation.
See: newCalculateRouteMatrixResponse smart constructor.
Constructors
| CalculateRouteMatrixResponse' | |
Fields
| |
Instances
newCalculateRouteMatrixResponse Source #
Arguments
| :: Int | |
| -> CalculateRouteMatrixSummary | |
| -> CalculateRouteMatrixResponse |
Create a value of CalculateRouteMatrixResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snappedDeparturePositions:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_snappedDeparturePositions - For routes calculated using an Esri route calculator resource, departure
positions are snapped to the closest road. For Esri route calculator
resources, this returns the list of departure/origin positions used for
calculation of the RouteMatrix.
$sel:snappedDestinationPositions:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_snappedDestinationPositions - The list of destination positions for the route matrix used for
calculation of the RouteMatrix.
$sel:httpStatus:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_httpStatus - The response's http status code.
$sel:routeMatrix:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_routeMatrix - The calculated route matrix containing the results for all pairs of
DeparturePositions to DestinationPositions. Each row corresponds to
one entry in DeparturePositions. Each entry in the row corresponds to
the route from that entry in DeparturePositions to an entry in
DestinationPositions.
$sel:summary:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_summary - Contains information about the route matrix, DataSource,
DistanceUnit, RouteCount and ErrorCount.
Response Lenses
calculateRouteMatrixResponse_snappedDeparturePositions :: Lens' CalculateRouteMatrixResponse (Maybe (NonEmpty (NonEmpty Double))) Source #
For routes calculated using an Esri route calculator resource, departure
positions are snapped to the closest road. For Esri route calculator
resources, this returns the list of departure/origin positions used for
calculation of the RouteMatrix.
calculateRouteMatrixResponse_snappedDestinationPositions :: Lens' CalculateRouteMatrixResponse (Maybe (NonEmpty (NonEmpty Double))) Source #
The list of destination positions for the route matrix used for
calculation of the RouteMatrix.
calculateRouteMatrixResponse_httpStatus :: Lens' CalculateRouteMatrixResponse Int Source #
The response's http status code.
calculateRouteMatrixResponse_routeMatrix :: Lens' CalculateRouteMatrixResponse [[RouteMatrixEntry]] Source #
The calculated route matrix containing the results for all pairs of
DeparturePositions to DestinationPositions. Each row corresponds to
one entry in DeparturePositions. Each entry in the row corresponds to
the route from that entry in DeparturePositions to an entry in
DestinationPositions.
calculateRouteMatrixResponse_summary :: Lens' CalculateRouteMatrixResponse CalculateRouteMatrixSummary Source #
Contains information about the route matrix, DataSource,
DistanceUnit, RouteCount and ErrorCount.