package Paws::LocationService::CalculateRoute; use Moose; has CalculatorName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'CalculatorName', required => 1); has CarModeOptions => (is => 'ro', isa => 'Paws::LocationService::CalculateRouteCarModeOptions'); has DepartNow => (is => 'ro', isa => 'Bool'); has DeparturePosition => (is => 'ro', isa => 'ArrayRef[Num]', required => 1); has DepartureTime => (is => 'ro', isa => 'Str'); has DestinationPosition => (is => 'ro', isa => 'ArrayRef[Num]', required => 1); has DistanceUnit => (is => 'ro', isa => 'Str'); has IncludeLegGeometry => (is => 'ro', isa => 'Bool'); has TravelMode => (is => 'ro', isa => 'Str'); has TruckModeOptions => (is => 'ro', isa => 'Paws::LocationService::CalculateRouteTruckModeOptions'); has WaypointPositions => (is => 'ro', isa => 'ArrayRef[ArrayRef[Num]]'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'CalculateRoute'); class_has _api_uri => (isa => 'Str', is => 'ro', default => '/routes/v0/calculators/{CalculatorName}/calculate/route'); class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LocationService::CalculateRouteResponse'); 1; ### main pod documentation begin ### =head1 NAME Paws::LocationService::CalculateRoute - Arguments for method CalculateRoute on L =head1 DESCRIPTION This class represents the parameters used for calling the method CalculateRoute on the L service. Use the attributes of this class as arguments to method CalculateRoute. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CalculateRoute. =head1 SYNOPSIS my $geo = Paws->service('LocationService'); my $CalculateRouteResponse = $geo->CalculateRoute( CalculatorName => 'MyResourceName', DeparturePosition => [ 1, ... ], DestinationPosition => [ 1, ... ], CarModeOptions => { AvoidFerries => 1, # OPTIONAL AvoidTolls => 1, # OPTIONAL }, # OPTIONAL DepartNow => 1, # OPTIONAL DepartureTime => '1970-01-01T01:00:00', # OPTIONAL DistanceUnit => 'Kilometers', # OPTIONAL IncludeLegGeometry => 1, # OPTIONAL TravelMode => 'Car', # OPTIONAL TruckModeOptions => { AvoidFerries => 1, # OPTIONAL AvoidTolls => 1, # OPTIONAL Dimensions => { Height => 1, # OPTIONAL Length => 1, # OPTIONAL Unit => 'Meters', # values: Meters, Feet; OPTIONAL Width => 1, # OPTIONAL }, # OPTIONAL Weight => { Total => 1, # OPTIONAL Unit => 'Kilograms', # values: Kilograms, Pounds; OPTIONAL }, # OPTIONAL }, # OPTIONAL WaypointPositions => [ [ 1, ... ], ... # min: 2, max: 2 ], # OPTIONAL ); # Results: my $Legs = $CalculateRouteResponse->Legs; my $Summary = $CalculateRouteResponse->Summary; # Returns a L object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 B CalculatorName => Str The name of the route calculator resource that you want to use to calculate a route. =head2 CarModeOptions => L Specifies route preferences when traveling by C, such as avoiding routes that use ferries or tolls. Requirements: C must be specified as C. =head2 DepartNow => Bool 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: C Valid Values: C | C =head2 B DeparturePosition => ArrayRef[Num] The start position for the route. Defined in WGS 84 (https://earth-info.nga.mil/GandG/wgs84/index.html) format: C<[longitude, latitude]>. =over =item * For example, C<[-123.115, 49.285]> =back If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road). Valid Values: C<[-180 to 180,-90 to 90]> =head2 DepartureTime => Str Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route. Setting a departure time in the past returns a C<400 ValidationException> error. =over =item * In ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: C. For example, C<2020E07-2T12:15:20.000Z+01:00> =back =head2 B DestinationPosition => ArrayRef[Num] The finish position for the route. Defined in WGS 84 (https://earth-info.nga.mil/GandG/wgs84/index.html) format: C<[longitude, latitude]>. =over =item * For example, C<[-122.339, 47.615]> =back If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road). Valid Values: C<[-180 to 180,-90 to 90]> =head2 DistanceUnit => Str Set the unit system to specify the distance. Default Value: C Valid values are: C<"Kilometers">, C<"Miles"> =head2 IncludeLegGeometry => Bool Set to include the geometry details in the result for each path between a pair of positions. Default Value: C Valid Values: C | C =head2 TravelMode => Str Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. The C you specify determines how you specify route preferences: =over =item * If traveling by C use the C parameter. =item * If traveling by C use the C parameter. =back Default Value: C Valid values are: C<"Car">, C<"Truck">, C<"Walking"> =head2 TruckModeOptions => L Specifies route preferences when traveling by C, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road. Requirements: C must be specified as C. =head2 WaypointPositions => ArrayRef[ArrayRef[Num]] Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. =over =item * For example, from the C C<[-123.115, 49.285]>, the route follows the order that the waypoint positions are given C<[[-122.757, 49.0021],[-122.349, 47.620]]> =back If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road). Specifying more than 23 waypoints returns a C<400 ValidationException> error. Valid Values: C<[-180 to 180,-90 to 90]> =head1 SEE ALSO This class forms part of L, documenting arguments for method CalculateRoute in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut