CalculateRouteMatrixRequest

import type { CalculateRouteMatrixRequest } from "https://aws-api.deno.dev/v0.3/services/location.ts?docs=full";

interface CalculateRouteMatrixRequest {

CalculatorName: string;

CarModeOptions?: CalculateRouteCarModeOptions | null;

DepartNow?: boolean | null;

DeparturePositions: number[][];

DepartureTime?: Date | number | null;

DestinationPositions: number[][];

DistanceUnit?: DistanceUnit | null;

TravelMode?: TravelMode | null;

TruckModeOptions?: CalculateRouteTruckModeOptions | null;

}

§Properties

CalculatorName: string

[src]

The name of the route calculator resource that you want to use to calculate the route matrix.

CarModeOptions?: CalculateRouteCarModeOptions | null

[src]

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

DepartNow?: boolean | null

[src]

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

DeparturePositions: number[][]

[src]

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].

! IMPORTANT: ! 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.

Note: 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]

DepartureTime?: Date | number | null

[src]

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.

Note: 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

DestinationPositions: number[][]

[src]

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]

Note: 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]

DistanceUnit?: DistanceUnit | null

[src]

Set the unit system to specify the distance.

Default Value: Kilometers

TravelMode?: TravelMode | null

[src]

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 Car use the CarModeOptions parameter.
If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

TruckModeOptions?: CalculateRouteTruckModeOptions | null

[src]

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.