CalculateIsolines

$result = $client->calculateIsolines([/* ... */]);
$promise = $client->calculateIsolinesAsync([/* ... */]);

Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time.

Isolines (also known as isochrones for time-based calculations) are useful for various applications including:

• Service area visualization - Show customers the area you can serve within promised delivery times

• Site selection - Analyze potential business locations based on population within travel distance

• Site selection - Determine areas that can be reached within specified response times

For more information, see Calculate isolines in the Amazon Location Service Developer Guide.

Parameter Syntax

$result = $client->calculateIsolines([
    'Allow' => [
        'Hot' => true || false,
        'Hov' => true || false,
    ],
    'ArrivalTime' => '<string>',
    'Avoid' => [
        'Areas' => [
            [
                'Except' => [
                    [
                        'BoundingBox' => [<float>, ...],
                        'Corridor' => [
                            'LineString' => [ // REQUIRED
                                [<float>, ...],
                                // ...
                            ],
                            'Radius' => <integer>, // REQUIRED
                        ],
                        'Polygon' => [
                            [
                                [<float>, ...],
                                // ...
                            ],
                            // ...
                        ],
                        'PolylineCorridor' => [
                            'Polyline' => '<string>', // REQUIRED
                            'Radius' => <integer>, // REQUIRED
                        ],
                        'PolylinePolygon' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Geometry' => [ // REQUIRED
                    'BoundingBox' => [<float>, ...],
                    'Corridor' => [
                        'LineString' => [ // REQUIRED
                            [<float>, ...],
                            // ...
                        ],
                        'Radius' => <integer>, // REQUIRED
                    ],
                    'Polygon' => [
                        [
                            [<float>, ...],
                            // ...
                        ],
                        // ...
                    ],
                    'PolylineCorridor' => [
                        'Polyline' => '<string>', // REQUIRED
                        'Radius' => <integer>, // REQUIRED
                    ],
                    'PolylinePolygon' => ['<string>', ...],
                ],
            ],
            // ...
        ],
        'CarShuttleTrains' => true || false,
        'ControlledAccessHighways' => true || false,
        'DirtRoads' => true || false,
        'Ferries' => true || false,
        'SeasonalClosure' => true || false,
        'TollRoads' => true || false,
        'TollTransponders' => true || false,
        'TruckRoadTypes' => ['<string>', ...],
        'Tunnels' => true || false,
        'UTurns' => true || false,
        'ZoneCategories' => [
            [
                'Category' => 'CongestionPricing|Environmental|Vignette',
            ],
            // ...
        ],
    ],
    'DepartNow' => true || false,
    'DepartureTime' => '<string>',
    'Destination' => [<float>, ...],
    'DestinationOptions' => [
        'AvoidActionsForDistance' => <integer>,
        'Heading' => <float>,
        'Matching' => [
            'NameHint' => '<string>',
            'OnRoadThreshold' => <integer>,
            'Radius' => <integer>,
            'Strategy' => 'MatchAny|MatchMostSignificantRoad',
        ],
        'SideOfStreet' => [
            'Position' => [<float>, ...], // REQUIRED
            'UseWith' => 'AnyStreet|DividedStreetOnly',
        ],
    ],
    'IsolineGeometryFormat' => 'FlexiblePolyline|Simple',
    'IsolineGranularity' => [
        'MaxPoints' => <integer>,
        'MaxResolution' => <integer>,
    ],
    'Key' => '<string>',
    'OptimizeIsolineFor' => 'AccurateCalculation|BalancedCalculation|FastCalculation',
    'OptimizeRoutingFor' => 'FastestRoute|ShortestRoute',
    'Origin' => [<float>, ...],
    'OriginOptions' => [
        'AvoidActionsForDistance' => <integer>,
        'Heading' => <float>,
        'Matching' => [
            'NameHint' => '<string>',
            'OnRoadThreshold' => <integer>,
            'Radius' => <integer>,
            'Strategy' => 'MatchAny|MatchMostSignificantRoad',
        ],
        'SideOfStreet' => [
            'Position' => [<float>, ...], // REQUIRED
            'UseWith' => 'AnyStreet|DividedStreetOnly',
        ],
    ],
    'Thresholds' => [ // REQUIRED
        'Distance' => [<integer>, ...],
        'Time' => [<integer>, ...],
    ],
    'Traffic' => [
        'FlowEventThresholdOverride' => <integer>,
        'Usage' => 'IgnoreTrafficData|UseTrafficData',
    ],
    'TravelMode' => 'Car|Pedestrian|Scooter|Truck',
    'TravelModeOptions' => [
        'Car' => [
            'EngineType' => 'Electric|InternalCombustion|PluginHybrid',
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
        ],
        'Scooter' => [
            'EngineType' => 'Electric|InternalCombustion|PluginHybrid',
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
        ],
        'Truck' => [
            'AxleCount' => <integer>,
            'EngineType' => 'Electric|InternalCombustion|PluginHybrid',
            'GrossWeight' => <integer>,
            'HazardousCargos' => ['<string>', ...],
            'Height' => <integer>,
            'HeightAboveFirstAxle' => <integer>,
            'KpraLength' => <integer>,
            'Length' => <integer>,
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
            'PayloadCapacity' => <integer>,
            'TireCount' => <integer>,
            'Trailer' => [
                'AxleCount' => <integer>,
                'TrailerCount' => <integer>,
            ],
            'TruckType' => 'LightTruck|StraightTruck|Tractor',
            'TunnelRestrictionCode' => '<string>',
            'WeightPerAxle' => <integer>,
            'WeightPerAxleGroup' => [
                'Quad' => <integer>,
                'Quint' => <integer>,
                'Single' => <integer>,
                'Tandem' => <integer>,
                'Triple' => <integer>,
            ],
            'Width' => <integer>,
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'ArrivalTime' => '<string>',
    'DepartureTime' => '<string>',
    'IsolineGeometryFormat' => 'FlexiblePolyline|Simple',
    'Isolines' => [
        [
            'Connections' => [
                [
                    'FromPolygonIndex' => <integer>,
                    'Geometry' => [
                        'LineString' => [
                            [<float>, ...],
                            // ...
                        ],
                        'Polyline' => '<string>',
                    ],
                    'ToPolygonIndex' => <integer>,
                ],
                // ...
            ],
            'DistanceThreshold' => <integer>,
            'Geometries' => [
                [
                    'Polygon' => [
                        [
                            [<float>, ...],
                            // ...
                        ],
                        // ...
                    ],
                    'PolylinePolygon' => ['<string>', ...],
                ],
                // ...
            ],
            'TimeThreshold' => <integer>,
        ],
        // ...
    ],
    'PricingBucket' => '<string>',
    'SnappedDestination' => [<float>, ...],
    'SnappedOrigin' => [<float>, ...],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException:

The request was denied due to request throttling.

CalculateRouteMatrix

$result = $client->calculateRouteMatrix([/* ... */]);
$promise = $client->calculateRouteMatrixAsync([/* ... */]);

Use CalculateRouteMatrix to compute results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.

For more information, see Calculate route matrix in the Amazon Location Service Developer Guide.

Parameter Syntax

$result = $client->calculateRouteMatrix([
    'Allow' => [
        'Hot' => true || false,
        'Hov' => true || false,
    ],
    'Avoid' => [
        'Areas' => [
            [
                'Geometry' => [ // REQUIRED
                    'BoundingBox' => [<float>, ...],
                    'Polygon' => [
                        [
                            [<float>, ...],
                            // ...
                        ],
                        // ...
                    ],
                    'PolylinePolygon' => ['<string>', ...],
                ],
            ],
            // ...
        ],
        'CarShuttleTrains' => true || false,
        'ControlledAccessHighways' => true || false,
        'DirtRoads' => true || false,
        'Ferries' => true || false,
        'TollRoads' => true || false,
        'TollTransponders' => true || false,
        'TruckRoadTypes' => ['<string>', ...],
        'Tunnels' => true || false,
        'UTurns' => true || false,
        'ZoneCategories' => [
            [
                'Category' => 'CongestionPricing|Environmental|Vignette',
            ],
            // ...
        ],
    ],
    'DepartNow' => true || false,
    'DepartureTime' => '<string>',
    'Destinations' => [ // REQUIRED
        [
            'Options' => [
                'AvoidActionsForDistance' => <integer>,
                'Heading' => <float>,
                'Matching' => [
                    'NameHint' => '<string>',
                    'OnRoadThreshold' => <integer>,
                    'Radius' => <integer>,
                    'Strategy' => 'MatchAny|MatchMostSignificantRoad',
                ],
                'SideOfStreet' => [
                    'Position' => [<float>, ...], // REQUIRED
                    'UseWith' => 'AnyStreet|DividedStreetOnly',
                ],
            ],
            'Position' => [<float>, ...], // REQUIRED
        ],
        // ...
    ],
    'Exclude' => [
        'Countries' => ['<string>', ...], // REQUIRED
    ],
    'Key' => '<string>',
    'OptimizeRoutingFor' => 'FastestRoute|ShortestRoute',
    'Origins' => [ // REQUIRED
        [
            'Options' => [
                'AvoidActionsForDistance' => <integer>,
                'Heading' => <float>,
                'Matching' => [
                    'NameHint' => '<string>',
                    'OnRoadThreshold' => <integer>,
                    'Radius' => <integer>,
                    'Strategy' => 'MatchAny|MatchMostSignificantRoad',
                ],
                'SideOfStreet' => [
                    'Position' => [<float>, ...], // REQUIRED
                    'UseWith' => 'AnyStreet|DividedStreetOnly',
                ],
            ],
            'Position' => [<float>, ...], // REQUIRED
        ],
        // ...
    ],
    'RoutingBoundary' => [
        'Geometry' => [
            'AutoCircle' => [
                'Margin' => <integer>,
                'MaxRadius' => <integer>,
            ],
            'BoundingBox' => [<float>, ...],
            'Circle' => [
                'Center' => [<float>, ...], // REQUIRED
                'Radius' => <float>, // REQUIRED
            ],
            'Polygon' => [
                [
                    [<float>, ...],
                    // ...
                ],
                // ...
            ],
        ],
        'Unbounded' => true || false,
    ],
    'Traffic' => [
        'FlowEventThresholdOverride' => <integer>,
        'Usage' => 'IgnoreTrafficData|UseTrafficData',
    ],
    'TravelMode' => 'Car|Pedestrian|Scooter|Truck',
    'TravelModeOptions' => [
        'Car' => [
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
        ],
        'Scooter' => [
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
        ],
        'Truck' => [
            'AxleCount' => <integer>,
            'GrossWeight' => <integer>,
            'HazardousCargos' => ['<string>', ...],
            'Height' => <integer>,
            'KpraLength' => <integer>,
            'Length' => <integer>,
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
            'PayloadCapacity' => <integer>,
            'Trailer' => [
                'TrailerCount' => <integer>,
            ],
            'TruckType' => 'LightTruck|StraightTruck|Tractor',
            'TunnelRestrictionCode' => '<string>',
            'WeightPerAxle' => <integer>,
            'WeightPerAxleGroup' => [
                'Quad' => <integer>,
                'Quint' => <integer>,
                'Single' => <integer>,
                'Tandem' => <integer>,
                'Triple' => <integer>,
            ],
            'Width' => <integer>,
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'ErrorCount' => <integer>,
    'PricingBucket' => '<string>',
    'RouteMatrix' => [
        [
            [
                'Distance' => <integer>,
                'Duration' => <integer>,
                'Error' => 'NoMatch|NoMatchDestination|NoMatchOrigin|NoRoute|OutOfBounds|OutOfBoundsDestination|OutOfBoundsOrigin|Other|Violation',
            ],
            // ...
        ],
        // ...
    ],
    'RoutingBoundary' => [
        'Geometry' => [
            'AutoCircle' => [
                'Margin' => <integer>,
                'MaxRadius' => <integer>,
            ],
            'BoundingBox' => [<float>, ...],
            'Circle' => [
                'Center' => [<float>, ...],
                'Radius' => <float>,
            ],
            'Polygon' => [
                [
                    [<float>, ...],
                    // ...
                ],
                // ...
            ],
        ],
        'Unbounded' => true || false,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException:

The request was denied due to request throttling.

CalculateRoutes

$result = $client->calculateRoutes([/* ... */]);
$promise = $client->calculateRoutesAsync([/* ... */]);

CalculateRoutes computes routes given the following required parameters: Origin and Destination.

For more information, see Calculate routes in the Amazon Location Service Developer Guide.

Parameter Syntax

$result = $client->calculateRoutes([
    'Allow' => [
        'Hot' => true || false,
        'Hov' => true || false,
    ],
    'ArrivalTime' => '<string>',
    'Avoid' => [
        'Areas' => [
            [
                'Except' => [
                    [
                        'BoundingBox' => [<float>, ...],
                        'Corridor' => [
                            'LineString' => [ // REQUIRED
                                [<float>, ...],
                                // ...
                            ],
                            'Radius' => <integer>, // REQUIRED
                        ],
                        'Polygon' => [
                            [
                                [<float>, ...],
                                // ...
                            ],
                            // ...
                        ],
                        'PolylineCorridor' => [
                            'Polyline' => '<string>', // REQUIRED
                            'Radius' => <integer>, // REQUIRED
                        ],
                        'PolylinePolygon' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Geometry' => [ // REQUIRED
                    'BoundingBox' => [<float>, ...],
                    'Corridor' => [
                        'LineString' => [ // REQUIRED
                            [<float>, ...],
                            // ...
                        ],
                        'Radius' => <integer>, // REQUIRED
                    ],
                    'Polygon' => [
                        [
                            [<float>, ...],
                            // ...
                        ],
                        // ...
                    ],
                    'PolylineCorridor' => [
                        'Polyline' => '<string>', // REQUIRED
                        'Radius' => <integer>, // REQUIRED
                    ],
                    'PolylinePolygon' => ['<string>', ...],
                ],
            ],
            // ...
        ],
        'CarShuttleTrains' => true || false,
        'ControlledAccessHighways' => true || false,
        'DirtRoads' => true || false,
        'Ferries' => true || false,
        'SeasonalClosure' => true || false,
        'TollRoads' => true || false,
        'TollTransponders' => true || false,
        'TruckRoadTypes' => ['<string>', ...],
        'Tunnels' => true || false,
        'UTurns' => true || false,
        'ZoneCategories' => [
            [
                'Category' => 'CongestionPricing|Environmental|Vignette', // REQUIRED
            ],
            // ...
        ],
    ],
    'DepartNow' => true || false,
    'DepartureTime' => '<string>',
    'Destination' => [<float>, ...], // REQUIRED
    'DestinationOptions' => [
        'AvoidActionsForDistance' => <integer>,
        'AvoidUTurns' => true || false,
        'Heading' => <float>,
        'Matching' => [
            'NameHint' => '<string>',
            'OnRoadThreshold' => <integer>,
            'Radius' => <integer>,
            'Strategy' => 'MatchAny|MatchMostSignificantRoad',
        ],
        'SideOfStreet' => [
            'Position' => [<float>, ...], // REQUIRED
            'UseWith' => 'AnyStreet|DividedStreetOnly',
        ],
        'StopDuration' => <integer>,
    ],
    'Driver' => [
        'Schedule' => [
            [
                'DriveDuration' => <integer>, // REQUIRED
                'RestDuration' => <integer>, // REQUIRED
            ],
            // ...
        ],
    ],
    'Exclude' => [
        'Countries' => ['<string>', ...], // REQUIRED
    ],
    'InstructionsMeasurementSystem' => 'Metric|Imperial',
    'Key' => '<string>',
    'Languages' => ['<string>', ...],
    'LegAdditionalFeatures' => ['<string>', ...],
    'LegGeometryFormat' => 'FlexiblePolyline|Simple',
    'MaxAlternatives' => <integer>,
    'OptimizeRoutingFor' => 'FastestRoute|ShortestRoute',
    'Origin' => [<float>, ...], // REQUIRED
    'OriginOptions' => [
        'AvoidActionsForDistance' => <integer>,
        'AvoidUTurns' => true || false,
        'Heading' => <float>,
        'Matching' => [
            'NameHint' => '<string>',
            'OnRoadThreshold' => <integer>,
            'Radius' => <integer>,
            'Strategy' => 'MatchAny|MatchMostSignificantRoad',
        ],
        'SideOfStreet' => [
            'Position' => [<float>, ...], // REQUIRED
            'UseWith' => 'AnyStreet|DividedStreetOnly',
        ],
    ],
    'SpanAdditionalFeatures' => ['<string>', ...],
    'Tolls' => [
        'AllTransponders' => true || false,
        'AllVignettes' => true || false,
        'Currency' => '<string>',
        'EmissionType' => [
            'Co2EmissionClass' => '<string>',
            'Type' => '<string>', // REQUIRED
        ],
        'VehicleCategory' => 'Minibus',
    ],
    'Traffic' => [
        'FlowEventThresholdOverride' => <integer>,
        'Usage' => 'IgnoreTrafficData|UseTrafficData',
    ],
    'TravelMode' => 'Car|Pedestrian|Scooter|Truck',
    'TravelModeOptions' => [
        'Car' => [
            'EngineType' => 'Electric|InternalCombustion|PluginHybrid',
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
        ],
        'Pedestrian' => [
            'Speed' => <float>,
        ],
        'Scooter' => [
            'EngineType' => 'Electric|InternalCombustion|PluginHybrid',
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
        ],
        'Truck' => [
            'AxleCount' => <integer>,
            'EngineType' => 'Electric|InternalCombustion|PluginHybrid',
            'GrossWeight' => <integer>,
            'HazardousCargos' => ['<string>', ...],
            'Height' => <integer>,
            'HeightAboveFirstAxle' => <integer>,
            'KpraLength' => <integer>,
            'Length' => <integer>,
            'LicensePlate' => [
                'LastCharacter' => '<string>',
            ],
            'MaxSpeed' => <float>,
            'Occupancy' => <integer>,
            'PayloadCapacity' => <integer>,
            'TireCount' => <integer>,
            'Trailer' => [
                'AxleCount' => <integer>,
                'TrailerCount' => <integer>,
            ],
            'TruckType' => 'LightTruck|StraightTruck|Tractor',
            'TunnelRestrictionCode' => '<string>',
            'WeightPerAxle' => <integer>,
            'WeightPerAxleGroup' => [
                'Quad' => <integer>,
                'Quint' => <integer>,
                'Single' => <integer>,
                'Tandem' => <integer>,
                'Triple' => <integer>,
            ],
            'Width' => <integer>,
        ],
    ],
    'TravelStepType' => 'Default|TurnByTurn',
    'Waypoints' => [
        [
            'AvoidActionsForDistance' => <integer>,
            'AvoidUTurns' => true || false,
            'Heading' => <float>,
            'Matching' => [
                'NameHint' => '<string>',
                'OnRoadThreshold' => <integer>,
                'Radius' => <integer>,
                'Strategy' => 'MatchAny|MatchMostSignificantRoad',
            ],
            'PassThrough' => true || false,
            'Position' => [<float>, ...], // REQUIRED
            'SideOfStreet' => [
                'Position' => [<float>, ...], // REQUIRED
                'UseWith' => 'AnyStreet|DividedStreetOnly',
            ],
            'StopDuration' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LegGeometryFormat' => 'FlexiblePolyline|Simple',
    'Notices' => [
        [
            'Code' => 'MainLanguageNotFound|Other|TravelTimeExceedsDriverWorkHours',
            'Impact' => 'High|Low',
        ],
        // ...
    ],
    'PricingBucket' => '<string>',
    'Routes' => [
        [
            'Legs' => [
                [
                    'FerryLegDetails' => [
                        'AfterTravelSteps' => [
                            [
                                'Duration' => <integer>,
                                'Instruction' => '<string>',
                                'Type' => 'Deboard',
                            ],
                            // ...
                        ],
                        'Arrival' => [
                            'Place' => [
                                'Name' => '<string>',
                                'OriginalPosition' => [<float>, ...],
                                'Position' => [<float>, ...],
                                'WaypointIndex' => <integer>,
                            ],
                            'Time' => '<string>',
                        ],
                        'BeforeTravelSteps' => [
                            [
                                'Duration' => <integer>,
                                'Instruction' => '<string>',
                                'Type' => 'Board',
                            ],
                            // ...
                        ],
                        'Departure' => [
                            'Place' => [
                                'Name' => '<string>',
                                'OriginalPosition' => [<float>, ...],
                                'Position' => [<float>, ...],
                                'WaypointIndex' => <integer>,
                            ],
                            'Time' => '<string>',
                        ],
                        'Notices' => [
                            [
                                'Code' => 'AccuratePolylineUnavailable|NoSchedule|Other|ViolatedAvoidFerry|ViolatedAvoidRailFerry|SeasonalClosure|PotentialViolatedVehicleRestrictionUsage',
                                'Impact' => 'High|Low',
                            ],
                            // ...
                        ],
                        'PassThroughWaypoints' => [
                            [
                                'GeometryOffset' => <integer>,
                                'Place' => [
                                    'OriginalPosition' => [<float>, ...],
                                    'Position' => [<float>, ...],
                                    'WaypointIndex' => <integer>,
                                ],
                            ],
                            // ...
                        ],
                        'RouteName' => '<string>',
                        'Spans' => [
                            [
                                'Country' => '<string>',
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                                'GeometryOffset' => <integer>,
                                'Names' => [
                                    [
                                        'Language' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Region' => '<string>',
                            ],
                            // ...
                        ],
                        'Summary' => [
                            'Overview' => [
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                            ],
                            'TravelOnly' => [
                                'Duration' => <integer>,
                            ],
                        ],
                        'TravelSteps' => [
                            [
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                                'GeometryOffset' => <integer>,
                                'Instruction' => '<string>',
                                'Type' => 'Depart|Continue|Arrive',
                            ],
                            // ...
                        ],
                    ],
                    'Geometry' => [
                        'LineString' => [
                            [<float>, ...],
                            // ...
                        ],
                        'Polyline' => '<string>',
                    ],
                    'Language' => '<string>',
                    'PedestrianLegDetails' => [
                        'Arrival' => [
                            'Place' => [
                                'Name' => '<string>',
                                'OriginalPosition' => [<float>, ...],
                                'Position' => [<float>, ...],
                                'SideOfStreet' => 'Left|Right',
                                'WaypointIndex' => <integer>,
                            ],
                            'Time' => '<string>',
                        ],
                        'Departure' => [
                            'Place' => [
                                'Name' => '<string>',
                                'OriginalPosition' => [<float>, ...],
                                'Position' => [<float>, ...],
                                'SideOfStreet' => 'Left|Right',
                                'WaypointIndex' => <integer>,
                            ],
                            'Time' => '<string>',
                        ],
                        'Notices' => [
                            [
                                'Code' => 'AccuratePolylineUnavailable|Other|ViolatedAvoidDirtRoad|ViolatedAvoidTunnel|ViolatedPedestrianOption',
                                'Impact' => 'High|Low',
                            ],
                            // ...
                        ],
                        'PassThroughWaypoints' => [
                            [
                                'GeometryOffset' => <integer>,
                                'Place' => [
                                    'OriginalPosition' => [<float>, ...],
                                    'Position' => [<float>, ...],
                                    'WaypointIndex' => <integer>,
                                ],
                            ],
                            // ...
                        ],
                        'Spans' => [
                            [
                                'BestCaseDuration' => <integer>,
                                'Country' => '<string>',
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                                'DynamicSpeed' => [
                                    'BestCaseSpeed' => <float>,
                                    'TurnDuration' => <integer>,
                                    'TypicalSpeed' => <float>,
                                ],
                                'FunctionalClassification' => <integer>,
                                'GeometryOffset' => <integer>,
                                'Incidents' => [<integer>, ...],
                                'Names' => [
                                    [
                                        'Language' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'PedestrianAccess' => ['<string>', ...],
                                'Region' => '<string>',
                                'RoadAttributes' => ['<string>', ...],
                                'RouteNumbers' => [
                                    [
                                        'Direction' => 'East|North|South|West',
                                        'Language' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'SpeedLimit' => [
                                    'MaxSpeed' => <float>,
                                    'Unlimited' => true || false,
                                ],
                                'TypicalDuration' => <integer>,
                            ],
                            // ...
                        ],
                        'Summary' => [
                            'Overview' => [
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                            ],
                            'TravelOnly' => [
                                'Duration' => <integer>,
                            ],
                        ],
                        'TravelSteps' => [
                            [
                                'ContinueStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                'CurrentRoad' => [
                                    'RoadName' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'RouteNumber' => [
                                        [
                                            'Direction' => 'East|North|South|West',
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Towards' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Type' => 'Highway|Rural|Urban',
                                ],
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                                'ExitNumber' => [
                                    [
                                        'Language' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'GeometryOffset' => <integer>,
                                'Instruction' => '<string>',
                                'KeepStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'NextRoad' => [
                                    'RoadName' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'RouteNumber' => [
                                        [
                                            'Direction' => 'East|North|South|West',
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Towards' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Type' => 'Highway|Rural|Urban',
                                ],
                                'RoundaboutEnterStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'RoundaboutExitStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'RelativeExit' => <integer>,
                                    'RoundaboutAngle' => <float>,
                                    'SteeringDirection' => 'Left|Right|Straight',
                                ],
                                'RoundaboutPassStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'Signpost' => [
                                    'Labels' => [
                                        [
                                            'RouteNumber' => [
                                                'Direction' => 'East|North|South|West',
                                                'Language' => '<string>',
                                                'Value' => '<string>',
                                            ],
                                            'Text' => [
                                                'Language' => '<string>',
                                                'Value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'TurnStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'Type' => 'Arrive|Continue|Depart|Keep|RoundaboutEnter|RoundaboutExit|RoundaboutPass|Turn',
                            ],
                            // ...
                        ],
                    ],
                    'TravelMode' => 'Car|Ferry|Pedestrian|Scooter|Truck|CarShuttleTrain',
                    'Type' => 'Ferry|Pedestrian|Vehicle',
                    'VehicleLegDetails' => [
                        'Arrival' => [
                            'Place' => [
                                'Name' => '<string>',
                                'OriginalPosition' => [<float>, ...],
                                'Position' => [<float>, ...],
                                'SideOfStreet' => 'Left|Right',
                                'WaypointIndex' => <integer>,
                            ],
                            'Time' => '<string>',
                        ],
                        'Departure' => [
                            'Place' => [
                                'Name' => '<string>',
                                'OriginalPosition' => [<float>, ...],
                                'Position' => [<float>, ...],
                                'SideOfStreet' => 'Left|Right',
                                'WaypointIndex' => <integer>,
                            ],
                            'Time' => '<string>',
                        ],
                        'Incidents' => [
                            [
                                'Description' => '<string>',
                                'EndTime' => '<string>',
                                'Severity' => 'Critical|High|Medium|Low',
                                'StartTime' => '<string>',
                                'Type' => 'Accident|Congestion|Construction|DisabledVehicle|LaneRestriction|MassTransit|Other|PlannedEvent|RoadClosure|RoadHazard|Weather',
                            ],
                            // ...
                        ],
                        'Notices' => [
                            [
                                'Code' => 'AccuratePolylineUnavailable|Other|PotentialViolatedAvoidTollRoadUsage|PotentialViolatedCarpoolUsage|PotentialViolatedTurnRestrictionUsage|PotentialViolatedVehicleRestrictionUsage|PotentialViolatedZoneRestrictionUsage|SeasonalClosure|TollsDataTemporarilyUnavailable|TollsDataUnavailable|TollTransponder|ViolatedAvoidControlledAccessHighway|ViolatedAvoidDifficultTurns|ViolatedAvoidDirtRoad|ViolatedAvoidSeasonalClosure|ViolatedAvoidTollRoad|ViolatedAvoidTollTransponder|ViolatedAvoidTruckRoadType|ViolatedAvoidTunnel|ViolatedAvoidUTurns|ViolatedBlockedRoad|ViolatedCarpool|ViolatedEmergencyGate|ViolatedStartDirection|ViolatedTurnRestriction|ViolatedVehicleRestriction|ViolatedZoneRestriction',
                                'Details' => [
                                    [
                                        'Title' => '<string>',
                                        'ViolatedConstraints' => [
                                            'AllHazardsRestricted' => true || false,
                                            'AxleCount' => [
                                                'Max' => <integer>,
                                                'Min' => <integer>,
                                            ],
                                            'HazardousCargos' => ['<string>', ...],
                                            'MaxHeight' => <integer>,
                                            'MaxKpraLength' => <integer>,
                                            'MaxLength' => <integer>,
                                            'MaxPayloadCapacity' => <integer>,
                                            'MaxWeight' => [
                                                'Type' => 'Current|Gross|Unknown',
                                                'Value' => <integer>,
                                            ],
                                            'MaxWeightPerAxle' => <integer>,
                                            'MaxWeightPerAxleGroup' => [
                                                'Quad' => <integer>,
                                                'Quint' => <integer>,
                                                'Single' => <integer>,
                                                'Tandem' => <integer>,
                                                'Triple' => <integer>,
                                            ],
                                            'MaxWidth' => <integer>,
                                            'Occupancy' => [
                                                'Max' => <integer>,
                                                'Min' => <integer>,
                                            ],
                                            'RestrictedTimes' => '<string>',
                                            'TimeDependent' => true || false,
                                            'TrailerCount' => [
                                                'Max' => <integer>,
                                                'Min' => <integer>,
                                            ],
                                            'TravelMode' => true || false,
                                            'TruckRoadType' => '<string>',
                                            'TruckType' => 'LightTruck|StraightTruck|Tractor',
                                            'TunnelRestrictionCode' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                                'Impact' => 'High|Low',
                            ],
                            // ...
                        ],
                        'PassThroughWaypoints' => [
                            [
                                'GeometryOffset' => <integer>,
                                'Place' => [
                                    'OriginalPosition' => [<float>, ...],
                                    'Position' => [<float>, ...],
                                    'WaypointIndex' => <integer>,
                                ],
                            ],
                            // ...
                        ],
                        'Spans' => [
                            [
                                'BestCaseDuration' => <integer>,
                                'CarAccess' => ['<string>', ...],
                                'Country' => '<string>',
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                                'DynamicSpeed' => [
                                    'BestCaseSpeed' => <float>,
                                    'TurnDuration' => <integer>,
                                    'TypicalSpeed' => <float>,
                                ],
                                'FunctionalClassification' => <integer>,
                                'Gate' => 'Emergency|KeyAccess|PermissionRequired',
                                'GeometryOffset' => <integer>,
                                'Incidents' => [<integer>, ...],
                                'Names' => [
                                    [
                                        'Language' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Notices' => [<integer>, ...],
                                'RailwayCrossing' => 'Protected|Unprotected',
                                'Region' => '<string>',
                                'RoadAttributes' => ['<string>', ...],
                                'RouteNumbers' => [
                                    [
                                        'Direction' => 'East|North|South|West',
                                        'Language' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ScooterAccess' => ['<string>', ...],
                                'SpeedLimit' => [
                                    'MaxSpeed' => <float>,
                                    'Unlimited' => true || false,
                                ],
                                'TollSystems' => [<integer>, ...],
                                'TruckAccess' => ['<string>', ...],
                                'TruckRoadTypes' => [<integer>, ...],
                                'TypicalDuration' => <integer>,
                                'Zones' => [<integer>, ...],
                            ],
                            // ...
                        ],
                        'Summary' => [
                            'Overview' => [
                                'BestCaseDuration' => <integer>,
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                                'TypicalDuration' => <integer>,
                            ],
                            'TravelOnly' => [
                                'BestCaseDuration' => <integer>,
                                'Duration' => <integer>,
                                'TypicalDuration' => <integer>,
                            ],
                        ],
                        'TollSystems' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'Tolls' => [
                            [
                                'Country' => '<string>',
                                'PaymentSites' => [
                                    [
                                        'Name' => '<string>',
                                        'Position' => [<float>, ...],
                                    ],
                                    // ...
                                ],
                                'Rates' => [
                                    [
                                        'ApplicableTimes' => '<string>',
                                        'ConvertedPrice' => [
                                            'Currency' => '<string>',
                                            'Estimate' => true || false,
                                            'PerDuration' => <integer>,
                                            'Range' => true || false,
                                            'RangeValue' => [
                                                'Max' => <float>,
                                                'Min' => <float>,
                                            ],
                                            'Value' => <float>,
                                        ],
                                        'Id' => '<string>',
                                        'LocalPrice' => [
                                            'Currency' => '<string>',
                                            'Estimate' => true || false,
                                            'PerDuration' => <integer>,
                                            'Range' => true || false,
                                            'RangeValue' => [
                                                'Max' => <float>,
                                                'Min' => <float>,
                                            ],
                                            'Value' => <float>,
                                        ],
                                        'Name' => '<string>',
                                        'Pass' => [
                                            'IncludesReturnTrip' => true || false,
                                            'SeniorPass' => true || false,
                                            'TransferCount' => <integer>,
                                            'TripCount' => <integer>,
                                            'ValidityPeriod' => [
                                                'Period' => 'Annual|Days|ExtendedAnnual|Minutes|Months',
                                                'PeriodCount' => <integer>,
                                            ],
                                        ],
                                        'PaymentMethods' => ['<string>', ...],
                                        'Transponders' => [
                                            [
                                                'SystemName' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                    // ...
                                ],
                                'Systems' => [<integer>, ...],
                            ],
                            // ...
                        ],
                        'TravelSteps' => [
                            [
                                'ContinueHighwayStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'ContinueStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                'CurrentRoad' => [
                                    'RoadName' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'RouteNumber' => [
                                        [
                                            'Direction' => 'East|North|South|West',
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Towards' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Type' => 'Highway|Rural|Urban',
                                ],
                                'Distance' => <integer>,
                                'Duration' => <integer>,
                                'EnterHighwayStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'ExitNumber' => [
                                    [
                                        'Language' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ExitStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'RelativeExit' => <integer>,
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'GeometryOffset' => <integer>,
                                'Instruction' => '<string>',
                                'KeepStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'NextRoad' => [
                                    'RoadName' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'RouteNumber' => [
                                        [
                                            'Direction' => 'East|North|South|West',
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Towards' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Type' => 'Highway|Rural|Urban',
                                ],
                                'RampStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'RoundaboutEnterStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'RoundaboutExitStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'RelativeExit' => <integer>,
                                    'RoundaboutAngle' => <float>,
                                    'SteeringDirection' => 'Left|Right|Straight',
                                ],
                                'RoundaboutPassStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'Signpost' => [
                                    'Labels' => [
                                        [
                                            'RouteNumber' => [
                                                'Direction' => 'East|North|South|West',
                                                'Language' => '<string>',
                                                'Value' => '<string>',
                                            ],
                                            'Text' => [
                                                'Language' => '<string>',
                                                'Value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'TurnStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                                'Type' => 'Arrive|Continue|ContinueHighway|Depart|EnterHighway|Exit|Keep|Ramp|RoundaboutEnter|RoundaboutExit|RoundaboutPass|Turn|UTurn',
                                'UTurnStepDetails' => [
                                    'Intersection' => [
                                        [
                                            'Language' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'SteeringDirection' => 'Left|Right|Straight',
                                    'TurnAngle' => <float>,
                                    'TurnIntensity' => 'Sharp|Slight|Typical',
                                ],
                            ],
                            // ...
                        ],
                        'TruckRoadTypes' => ['<string>', ...],
                        'Zones' => [
                            [
                                'Category' => 'CongestionPricing|Environmental|Vignette',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
            'MajorRoadLabels' => [
                [
                    'RoadName' => [
                        'Language' => '<string>',
                        'Value' => '<string>',
                    ],
                    'RouteNumber' => [
                        'Direction' => 'East|North|South|West',
                        'Language' => '<string>',
                        'Value' => '<string>',
                    ],
                ],
                // ...
            ],
            'Summary' => [
                'Distance' => <integer>,
                'Duration' => <integer>,
                'Tolls' => [
                    'Total' => [
                        'Currency' => '<string>',
                        'Estimate' => true || false,
                        'Range' => true || false,
                        'RangeValue' => [
                            'Max' => <float>,
                            'Min' => <float>,
                        ],
                        'Value' => <float>,
                    ],
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException:

The request was denied due to request throttling.

OptimizeWaypoints

$result = $client->optimizeWaypoints([/* ... */]);
$promise = $client->optimizeWaypointsAsync([/* ... */]);

OptimizeWaypoints calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.

For more information, see Optimize waypoints in the Amazon Location Service Developer Guide.

Parameter Syntax

$result = $client->optimizeWaypoints([
    'Avoid' => [
        'Areas' => [
            [
                'Geometry' => [ // REQUIRED
                    'BoundingBox' => [<float>, ...],
                ],
            ],
            // ...
        ],
        'CarShuttleTrains' => true || false,
        'ControlledAccessHighways' => true || false,
        'DirtRoads' => true || false,
        'Ferries' => true || false,
        'TollRoads' => true || false,
        'Tunnels' => true || false,
        'UTurns' => true || false,
    ],
    'Clustering' => [
        'Algorithm' => 'DrivingDistance|TopologySegment', // REQUIRED
        'DrivingDistanceOptions' => [
            'DrivingDistance' => <integer>, // REQUIRED
        ],
    ],
    'DepartureTime' => '<string>',
    'Destination' => [<float>, ...],
    'DestinationOptions' => [
        'AccessHours' => [
            'From' => [ // REQUIRED
                'DayOfWeek' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday', // REQUIRED
                'TimeOfDay' => '<string>', // REQUIRED
            ],
            'To' => [ // REQUIRED
                'DayOfWeek' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday', // REQUIRED
                'TimeOfDay' => '<string>', // REQUIRED
            ],
        ],
        'AppointmentTime' => '<string>',
        'Heading' => <float>,
        'Id' => '<string>',
        'ServiceDuration' => <integer>,
        'SideOfStreet' => [
            'Position' => [<float>, ...], // REQUIRED
            'UseWith' => 'AnyStreet|DividedStreetOnly',
        ],
    ],
    'Driver' => [
        'RestCycles' => [
            'LongCycle' => [ // REQUIRED
                'RestDuration' => <integer>, // REQUIRED
                'WorkDuration' => <integer>, // REQUIRED
            ],
            'ShortCycle' => [ // REQUIRED
                'RestDuration' => <integer>, // REQUIRED
                'WorkDuration' => <integer>, // REQUIRED
            ],
        ],
        'RestProfile' => [
            'Profile' => '<string>', // REQUIRED
        ],
        'TreatServiceTimeAs' => 'Rest|Work',
    ],
    'Exclude' => [
        'Countries' => ['<string>', ...], // REQUIRED
    ],
    'Key' => '<string>',
    'OptimizeSequencingFor' => 'FastestRoute|ShortestRoute',
    'Origin' => [<float>, ...], // REQUIRED
    'OriginOptions' => [
        'Id' => '<string>',
    ],
    'Traffic' => [
        'Usage' => 'IgnoreTrafficData|UseTrafficData',
    ],
    'TravelMode' => 'Car|Pedestrian|Scooter|Truck',
    'TravelModeOptions' => [
        'Pedestrian' => [
            'Speed' => <float>,
        ],
        'Truck' => [
            'GrossWeight' => <integer>,
            'HazardousCargos' => ['<string>', ...],
            'Height' => <integer>,
            'Length' => <integer>,
            'Trailer' => [
                'TrailerCount' => <integer>,
            ],
            'TruckType' => 'StraightTruck|Tractor',
            'TunnelRestrictionCode' => '<string>',
            'WeightPerAxle' => <integer>,
            'Width' => <integer>,
        ],
    ],
    'Waypoints' => [
        [
            'AccessHours' => [
                'From' => [ // REQUIRED
                    'DayOfWeek' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday', // REQUIRED
                    'TimeOfDay' => '<string>', // REQUIRED
                ],
                'To' => [ // REQUIRED
                    'DayOfWeek' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday', // REQUIRED
                    'TimeOfDay' => '<string>', // REQUIRED
                ],
            ],
            'AppointmentTime' => '<string>',
            'Before' => [<integer>, ...],
            'Heading' => <float>,
            'Id' => '<string>',
            'Position' => [<float>, ...], // REQUIRED
            'ServiceDuration' => <integer>,
            'SideOfStreet' => [
                'Position' => [<float>, ...], // REQUIRED
                'UseWith' => 'AnyStreet|DividedStreetOnly',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Connections' => [
        [
            'Distance' => <integer>,
            'From' => '<string>',
            'RestDuration' => <integer>,
            'To' => '<string>',
            'TravelDuration' => <integer>,
            'WaitDuration' => <integer>,
        ],
        // ...
    ],
    'Distance' => <integer>,
    'Duration' => <integer>,
    'ImpedingWaypoints' => [
        [
            'FailedConstraints' => [
                [
                    'Constraint' => 'AccessHours|AppointmentTime|Before|Heading|ServiceDuration|SideOfStreet',
                    'Reason' => '<string>',
                ],
                // ...
            ],
            'Id' => '<string>',
            'Position' => [<float>, ...],
        ],
        // ...
    ],
    'OptimizedWaypoints' => [
        [
            'ArrivalTime' => '<string>',
            'ClusterIndex' => <integer>,
            'DepartureTime' => '<string>',
            'Id' => '<string>',
            'Position' => [<float>, ...],
        ],
        // ...
    ],
    'PricingBucket' => '<string>',
    'TimeBreakdown' => [
        'RestDuration' => <integer>,
        'ServiceDuration' => <integer>,
        'TravelDuration' => <integer>,
        'WaitDuration' => <integer>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException:

The request was denied due to request throttling.

SnapToRoads

$result = $client->snapToRoads([/* ... */]);
$promise = $client->snapToRoadsAsync([/* ... */]);

SnapToRoads matches GPS trace to roads most likely traveled on.

For more information, see Snap to Roads in the Amazon Location Service Developer Guide.

Parameter Syntax

$result = $client->snapToRoads([
    'Key' => '<string>',
    'SnapRadius' => <integer>,
    'SnappedGeometryFormat' => 'FlexiblePolyline|Simple',
    'TracePoints' => [ // REQUIRED
        [
            'Heading' => <float>,
            'Position' => [<float>, ...], // REQUIRED
            'Speed' => <float>,
            'Timestamp' => '<string>',
        ],
        // ...
    ],
    'TravelMode' => 'Car|Pedestrian|Scooter|Truck',
    'TravelModeOptions' => [
        'Truck' => [
            'GrossWeight' => <integer>,
            'HazardousCargos' => ['<string>', ...],
            'Height' => <integer>,
            'Length' => <integer>,
            'Trailer' => [
                'TrailerCount' => <integer>,
            ],
            'TunnelRestrictionCode' => '<string>',
            'Width' => <integer>,
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Notices' => [
        [
            'Code' => 'TracePointsHeadingIgnored|TracePointsIgnored|TracePointsMovedByLargeDistance|TracePointsNotMatched|TracePointsOutOfSequence|TracePointsSpeedEstimated|TracePointsSpeedIgnored',
            'Title' => '<string>',
            'TracePointIndexes' => [<integer>, ...],
        ],
        // ...
    ],
    'PricingBucket' => '<string>',
    'SnappedGeometry' => [
        'LineString' => [
            [<float>, ...],
            // ...
        ],
        'Polyline' => '<string>',
    ],
    'SnappedGeometryFormat' => 'FlexiblePolyline|Simple',
    'SnappedTracePoints' => [
        [
            'Confidence' => <float>,
            'OriginalPosition' => [<float>, ...],
            'SnappedPosition' => [<float>, ...],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException:

The request was denied due to request throttling.