AWSLocationCalculateRouteMatrixRequest

Objective-C

@interface AWSLocationCalculateRouteMatrixRequest

Swift

class AWSLocationCalculateRouteMatrixRequest

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable calculatorName;

    Swift

    var calculatorName: String? { get set }

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

    Requirements: TravelMode must be specified as Car.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLocationCalculateRouteCarModeOptions *_Nullable carModeOptions;

    Swift

    var carModeOptions: AWSLocationCalculateRouteCarModeOptions? { get set }

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable departNow;

    Swift

    var departNow: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSArray<NSNumber *> *> *_Nullable departurePositions;

    Swift

    var departurePositions: [[NSNumber]]? { get set }

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable departureTime;

    Swift

    var departureTime: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSArray<NSNumber *> *> *_Nullable destinationPositions;

    Swift

    var destinationPositions: [[NSNumber]]? { get set }

  • Set the unit system to specify the distance.

    Default Value: Kilometers

    Declaration

    Objective-C

    @property (nonatomic) AWSLocationDistanceUnit distanceUnit;

    Swift

    var distanceUnit: AWSLocationDistanceUnit { get set }
  • key

    The optional API key to authorize the request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable key;

    Swift

    var key: String? { get set }

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

    Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

    Truck is not available for Grab.

    For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

    Default Value: Car

    Declaration

    Objective-C

    @property (nonatomic) AWSLocationTravelMode travelMode;

    Swift

    var travelMode: AWSLocationTravelMode { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLocationCalculateRouteTruckModeOptions *_Nullable truckModeOptions;

    Swift

    var truckModeOptions: AWSLocationCalculateRouteTruckModeOptions? { get set }