AWSLocationCalculateRouteRequest

Objective-C

@interface AWSLocationCalculateRouteRequest

Swift

class AWSLocationCalculateRouteRequest

  • Specifies the desired time of arrival. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

    ArrivalTime is not supported Esri.

    Declaration

    Objective-C

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

    Swift

    var arrivalTime: Date? { get set }

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

    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 a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

    Default Value: false

    Valid Values: false | true

    Declaration

    Objective-C

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

    Swift

    var departNow: NSNumber? { get set }

  • The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

    • For example, [-123.115, 49.285]

    If you specify a departure that’s not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

    Valid Values: [-180 to 180,-90 to 90]

    Declaration

    Objective-C

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

    Swift

    var departurePosition: [NSNumber]? { get set }

  • Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

    • 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 finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

    • For example, [-122.339, 47.615]

    If you specify a destination that’s not located on a road, Amazon Location moves the position to the nearest road.

    Valid Values: [-180 to 180,-90 to 90]

    Declaration

    Objective-C

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

    Swift

    var destinationPosition: [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 }

  • Set to include the geometry details in the result for each path between a pair of positions.

    Default Value: false

    Valid Values: false | true

    Declaration

    Objective-C

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

    Swift

    var includeLegGeometry: NSNumber? { 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 distance to optimize for when calculating a route.

    Declaration

    Objective-C

    @property (nonatomic) AWSLocationOptimizationMode optimizeFor;

    Swift

    var optimizeFor: AWSLocationOptimizationMode { get set }

  • Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.

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

    Truck is not available for Grab.

    For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.

    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

    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 }

  • Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

    • For example, from the DeparturePosition[-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

    If you specify a waypoint position that’s not located on a road, Amazon Location moves the position to the nearest road.

    Specifying more than 23 waypoints returns a 400 ValidationException error.

    If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

    Valid Values: [-180 to 180,-90 to 90]

    Declaration

    Objective-C

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

    Swift

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