/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::LocationService::CalculateRouteSummary

NAME

Paws::LocationService::CalculateRouteSummary

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::LocationService::CalculateRouteSummary object:

$service_obj->Method(Att1 => { DataSource => $value, ..., RouteBBox => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::LocationService::CalculateRouteSummary object:

$result = $service_obj->Method(...);
$result->Att1->DataSource

DESCRIPTION

A summary of the calculated route.

ATTRIBUTES

REQUIRED DataSource => Str

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

  • Esri

  • Here

For more information about data providers, see Amazon Location Service data providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html).

REQUIRED Distance => Num

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

The route distance can't be greater than 250 km. If the route exceeds 250 km, the response returns a 400 RoutesValidationException error.

REQUIRED DistanceUnit => Str

The unit of measurement for the distance.

REQUIRED DurationSeconds => Num

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

REQUIRED RouteBBox => ArrayRef[Num]

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y]

The first 2 bbox parameters describe the lower southwest corner:

  • The first bbox position is the X coordinate or longitude of the lower southwest corner.

  • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

  • The third bbox position is the X coordinate, or longitude of the upper northeast corner.

  • The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::LocationService

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues