Class: Aws::LocationService::Types::CalculateRouteMatrixRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-locationservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:departure_positions, :destination_positions, :key]

Instance Attribute Summary collapse

Instance Attribute Details

#calculator_name ⇒ String

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

Returns:

  • (String) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#car_mode_options ⇒ Types::CalculateRouteCarModeOptions

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

Requirements: ‘TravelMode` must be specified as `Car`.

Returns:



792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#depart_now ⇒ Boolean

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`

Returns:

  • (Boolean) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#departure_positions ⇒ Array<Array<Float>>

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][1

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

<note markdown=“1”> 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`.

</note>

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

[1]: earth-info.nga.mil/GandG/wgs84/index.html [2]: docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits [3]: docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html

Returns:

  • (Array<Array<Float>>) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#departure_time ⇒ Time

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 markdown=“1”> Setting a departure time in the past returns a ‘400 ValidationException` error.

</note>

  • In [ISO 8601] format: ‘YYYY-MM-DDThh:mm:ss.sssZ`. For example, `2020–07-2T12:15:20.000Z+01:00`

^

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#destination_positions ⇒ Array<Array<Float>>

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

<note markdown=“1”> 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`.

</note>

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

[1]: earth-info.nga.mil/GandG/wgs84/index.html [2]: docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits [3]: docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html

Returns:

  • (Array<Array<Float>>) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#distance_unit ⇒ String

Set the unit system to specify the distance.

Default Value: ‘Kilometers`

Returns:

  • (String) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#key ⇒ String

The optional [API key] to authorize the request.

[1]: docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html

Returns:

  • (String) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#travel_mode ⇒ String

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.

<note markdown=“1”> ‘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][1

in the *Amazon Location Service Developer Guide*.

</note>

Default Value: ‘Car`

[1]: docs.aws.amazon.com/location/latest/developerguide/grab.html

Returns:

  • (String) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end

#truck_mode_options ⇒ Types::CalculateRouteTruckModeOptions

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

Returns:



792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-locationservice/types.rb', line 792

class CalculateRouteMatrixRequest < Struct.new(
  :calculator_name,
  :departure_positions,
  :destination_positions,
  :travel_mode,
  :departure_time,
  :depart_now,
  :distance_unit,
  :car_mode_options,
  :truck_mode_options,
  :key)
  SENSITIVE = [:departure_positions, :destination_positions, :key]
  include Aws::Structure
end