- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CalculateRoutesCommand
CalculateRoutes computes routes given the following required parameters: Origin and Destination.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { GeoRoutesClient, CalculateRoutesCommand } from "@aws-sdk/client-geo-routes"; // ES Modules import
// const { GeoRoutesClient, CalculateRoutesCommand } = require("@aws-sdk/client-geo-routes"); // CommonJS import
const client = new GeoRoutesClient(config);
const input = { // CalculateRoutesRequest
Allow: { // RouteAllowOptions
Hot: true || false,
Hov: true || false,
},
ArrivalTime: "STRING_VALUE",
Avoid: { // RouteAvoidanceOptions
Areas: [ // RouteAvoidanceAreaList
{ // RouteAvoidanceArea
Except: [ // RouteAvoidanceAreaGeometryList
{ // RouteAvoidanceAreaGeometry
Corridor: { // Corridor
LineString: [ // LineString // required
[ // Position
Number("double"),
],
],
Radius: Number("int"), // required
},
BoundingBox: [ // BoundingBox
Number("double"),
],
Polygon: [ // LinearRings
[ // LinearRing
[
Number("double"),
],
],
],
PolylineCorridor: { // PolylineCorridor
Polyline: "STRING_VALUE", // required
Radius: Number("int"), // required
},
PolylinePolygon: [ // PolylineRingList
"STRING_VALUE",
],
},
],
Geometry: {
Corridor: {
LineString: [ // required
[
Number("double"),
],
],
Radius: Number("int"), // required
},
BoundingBox: [
Number("double"),
],
Polygon: [
[
[
Number("double"),
],
],
],
PolylineCorridor: {
Polyline: "STRING_VALUE", // required
Radius: Number("int"), // required
},
PolylinePolygon: [
"STRING_VALUE",
],
},
},
],
CarShuttleTrains: true || false,
ControlledAccessHighways: true || false,
DirtRoads: true || false,
Ferries: true || false,
SeasonalClosure: true || false,
TollRoads: true || false,
TollTransponders: true || false,
TruckRoadTypes: [ // TruckRoadTypeList
"STRING_VALUE",
],
Tunnels: true || false,
UTurns: true || false,
ZoneCategories: [ // RouteAvoidanceZoneCategoryList
{ // RouteAvoidanceZoneCategory
Category: "STRING_VALUE", // required
},
],
},
DepartNow: true || false,
DepartureTime: "STRING_VALUE",
Destination: "<Position>", // required
DestinationOptions: { // RouteDestinationOptions
AvoidActionsForDistance: Number("long"),
AvoidUTurns: true || false,
Heading: Number("double"),
Matching: { // RouteMatchingOptions
NameHint: "STRING_VALUE",
OnRoadThreshold: Number("long"),
Radius: Number("long"),
Strategy: "STRING_VALUE",
},
SideOfStreet: { // RouteSideOfStreetOptions
Position: "<Position>", // required
UseWith: "STRING_VALUE",
},
StopDuration: Number("long"),
},
Driver: { // RouteDriverOptions
Schedule: [ // RouteDriverScheduleIntervalList
{ // RouteDriverScheduleInterval
DriveDuration: Number("long"), // required
RestDuration: Number("long"), // required
},
],
},
Exclude: { // RouteExclusionOptions
Countries: [ // CountryCodeList // required
"STRING_VALUE",
],
},
InstructionsMeasurementSystem: "STRING_VALUE",
Key: "STRING_VALUE",
Languages: [ // LanguageTagList
"STRING_VALUE",
],
LegAdditionalFeatures: [ // RouteLegAdditionalFeatureList
"STRING_VALUE",
],
LegGeometryFormat: "STRING_VALUE",
MaxAlternatives: Number("int"),
OptimizeRoutingFor: "STRING_VALUE",
Origin: "<Position>", // required
OriginOptions: { // RouteOriginOptions
AvoidActionsForDistance: Number("long"),
AvoidUTurns: true || false,
Heading: Number("double"),
Matching: {
NameHint: "STRING_VALUE",
OnRoadThreshold: Number("long"),
Radius: Number("long"),
Strategy: "STRING_VALUE",
},
SideOfStreet: {
Position: "<Position>", // required
UseWith: "STRING_VALUE",
},
},
SpanAdditionalFeatures: [ // RouteSpanAdditionalFeatureList
"STRING_VALUE",
],
Tolls: { // RouteTollOptions
AllTransponders: true || false,
AllVignettes: true || false,
Currency: "STRING_VALUE",
EmissionType: { // RouteEmissionType
Co2EmissionClass: "STRING_VALUE",
Type: "STRING_VALUE", // required
},
VehicleCategory: "STRING_VALUE",
},
Traffic: { // RouteTrafficOptions
FlowEventThresholdOverride: Number("long"),
Usage: "STRING_VALUE",
},
TravelMode: "STRING_VALUE",
TravelModeOptions: { // RouteTravelModeOptions
Car: { // RouteCarOptions
EngineType: "STRING_VALUE",
LicensePlate: { // RouteVehicleLicensePlate
LastCharacter: "STRING_VALUE",
},
MaxSpeed: Number("double"),
Occupancy: Number("int"),
},
Pedestrian: { // RoutePedestrianOptions
Speed: Number("double"),
},
Scooter: { // RouteScooterOptions
EngineType: "STRING_VALUE",
LicensePlate: {
LastCharacter: "STRING_VALUE",
},
MaxSpeed: Number("double"),
Occupancy: Number("int"),
},
Truck: { // RouteTruckOptions
AxleCount: Number("int"),
EngineType: "STRING_VALUE",
GrossWeight: Number("long"),
HazardousCargos: [ // RouteHazardousCargoTypeList
"STRING_VALUE",
],
Height: Number("long"),
HeightAboveFirstAxle: Number("long"),
KpraLength: Number("long"),
Length: Number("long"),
LicensePlate: {
LastCharacter: "STRING_VALUE",
},
MaxSpeed: Number("double"),
Occupancy: Number("int"),
PayloadCapacity: Number("long"),
TireCount: Number("int"),
Trailer: { // RouteTrailerOptions
AxleCount: Number("int"),
TrailerCount: Number("int"),
},
TruckType: "STRING_VALUE",
TunnelRestrictionCode: "STRING_VALUE",
WeightPerAxle: Number("long"),
WeightPerAxleGroup: { // WeightPerAxleGroup
Single: Number("long"),
Tandem: Number("long"),
Triple: Number("long"),
Quad: Number("long"),
Quint: Number("long"),
},
Width: Number("long"),
},
},
TravelStepType: "STRING_VALUE",
Waypoints: [ // RouteWaypointList
{ // RouteWaypoint
AvoidActionsForDistance: Number("long"),
AvoidUTurns: true || false,
Heading: Number("double"),
Matching: {
NameHint: "STRING_VALUE",
OnRoadThreshold: Number("long"),
Radius: Number("long"),
Strategy: "STRING_VALUE",
},
PassThrough: true || false,
Position: "<Position>", // required
SideOfStreet: {
Position: "<Position>", // required
UseWith: "STRING_VALUE",
},
StopDuration: Number("long"),
},
],
};
const command = new CalculateRoutesCommand(input);
const response = await client.send(command);
// { // CalculateRoutesResponse
// LegGeometryFormat: "STRING_VALUE", // required
// Notices: [ // RouteResponseNoticeList // required
// { // RouteResponseNotice
// Code: "STRING_VALUE", // required
// Impact: "STRING_VALUE",
// },
// ],
// PricingBucket: "STRING_VALUE", // required
// Routes: [ // RouteList // required
// { // Route
// Legs: [ // RouteLegList // required
// { // RouteLeg
// FerryLegDetails: { // RouteFerryLegDetails
// AfterTravelSteps: [ // RouteFerryAfterTravelStepList // required
// { // RouteFerryAfterTravelStep
// Duration: Number("long"), // required
// Instruction: "STRING_VALUE",
// Type: "STRING_VALUE", // required
// },
// ],
// Arrival: { // RouteFerryArrival
// Place: { // RouteFerryPlace
// Name: "STRING_VALUE",
// OriginalPosition: [ // Position23
// Number("double"),
// ],
// Position: [ // required
// Number("double"),
// ],
// WaypointIndex: Number("int"),
// },
// Time: "STRING_VALUE",
// },
// BeforeTravelSteps: [ // RouteFerryBeforeTravelStepList // required
// { // RouteFerryBeforeTravelStep
// Duration: Number("long"), // required
// Instruction: "STRING_VALUE",
// Type: "STRING_VALUE", // required
// },
// ],
// Departure: { // RouteFerryDeparture
// Place: {
// Name: "STRING_VALUE",
// OriginalPosition: [
// Number("double"),
// ],
// Position: [ // required
// Number("double"),
// ],
// WaypointIndex: Number("int"),
// },
// Time: "STRING_VALUE",
// },
// Notices: [ // RouteFerryNoticeList // required
// { // RouteFerryNotice
// Code: "STRING_VALUE", // required
// Impact: "STRING_VALUE",
// },
// ],
// PassThroughWaypoints: [ // RoutePassThroughWaypointList // required
// { // RoutePassThroughWaypoint
// GeometryOffset: Number("int"),
// Place: { // RoutePassThroughPlace
// OriginalPosition: [
// Number("double"),
// ],
// Position: "<Position23>", // required
// WaypointIndex: Number("int"),
// },
// },
// ],
// RouteName: "STRING_VALUE",
// Spans: [ // RouteFerrySpanList // required
// { // RouteFerrySpan
// Country: "STRING_VALUE",
// Distance: Number("long"),
// Duration: Number("long"),
// GeometryOffset: Number("int"),
// Names: [ // LocalizedStringList
// { // LocalizedString
// Language: "STRING_VALUE",
// Value: "STRING_VALUE", // required
// },
// ],
// Region: "STRING_VALUE",
// },
// ],
// Summary: { // RouteFerrySummary
// Overview: { // RouteFerryOverviewSummary
// Distance: Number("long"), // required
// Duration: Number("long"), // required
// },
// TravelOnly: { // RouteFerryTravelOnlySummary
// Duration: Number("long"), // required
// },
// },
// TravelSteps: [ // RouteFerryTravelStepList // required
// { // RouteFerryTravelStep
// Distance: Number("long"),
// Duration: Number("long"), // required
// GeometryOffset: Number("int"),
// Instruction: "STRING_VALUE",
// Type: "STRING_VALUE", // required
// },
// ],
// },
// Geometry: { // RouteLegGeometry
// LineString: [ // LineString
// [ // Position
// Number("double"),
// ],
// ],
// Polyline: "STRING_VALUE",
// },
// Language: "STRING_VALUE",
// PedestrianLegDetails: { // RoutePedestrianLegDetails
// Arrival: { // RoutePedestrianArrival
// Place: { // RoutePedestrianPlace
// Name: "STRING_VALUE",
// OriginalPosition: "<Position23>",
// Position: "<Position23>", // required
// SideOfStreet: "STRING_VALUE",
// WaypointIndex: Number("int"),
// },
// Time: "STRING_VALUE",
// },
// Departure: { // RoutePedestrianDeparture
// Place: {
// Name: "STRING_VALUE",
// OriginalPosition: "<Position23>",
// Position: "<Position23>", // required
// SideOfStreet: "STRING_VALUE",
// WaypointIndex: Number("int"),
// },
// Time: "STRING_VALUE",
// },
// Notices: [ // RoutePedestrianNoticeList // required
// { // RoutePedestrianNotice
// Code: "STRING_VALUE", // required
// Impact: "STRING_VALUE",
// },
// ],
// PassThroughWaypoints: [ // required
// {
// GeometryOffset: Number("int"),
// Place: {
// OriginalPosition: "<Position23>",
// Position: "<Position23>", // required
// WaypointIndex: Number("int"),
// },
// },
// ],
// Spans: [ // RoutePedestrianSpanList // required
// { // RoutePedestrianSpan
// BestCaseDuration: Number("long"),
// Country: "STRING_VALUE",
// Distance: Number("long"),
// Duration: Number("long"),
// DynamicSpeed: { // RouteSpanDynamicSpeedDetails
// BestCaseSpeed: Number("double"),
// TurnDuration: Number("long"),
// TypicalSpeed: Number("double"),
// },
// FunctionalClassification: Number("int"),
// GeometryOffset: Number("int"),
// Incidents: [ // IndexList
// Number("int"),
// ],
// Names: [
// {
// Language: "STRING_VALUE",
// Value: "STRING_VALUE", // required
// },
// ],
// PedestrianAccess: [ // RouteSpanPedestrianAccessAttributeList
// "STRING_VALUE",
// ],
// Region: "STRING_VALUE",
// RoadAttributes: [ // RouteSpanRoadAttributeList
// "STRING_VALUE",
// ],
// RouteNumbers: [ // RouteNumberList
// { // RouteNumber
// Direction: "STRING_VALUE",
// Language: "STRING_VALUE",
// Value: "STRING_VALUE", // required
// },
// ],
// SpeedLimit: { // RouteSpanSpeedLimitDetails
// MaxSpeed: Number("double"),
// Unlimited: true || false,
// },
// TypicalDuration: Number("long"),
// },
// ],
// Summary: { // RoutePedestrianSummary
// Overview: { // RoutePedestrianOverviewSummary
// Distance: Number("long"), // required
// Duration: Number("long"), // required
// },
// TravelOnly: { // RoutePedestrianTravelOnlySummary
// Duration: Number("long"), // required
// },
// },
// TravelSteps: [ // RoutePedestrianTravelStepList // required
// { // RoutePedestrianTravelStep
// ContinueStepDetails: { // RouteContinueStepDetails
// Intersection: [ // required
// {
// Language: "STRING_VALUE",
// Value: "STRING_VALUE", // required
// },
// ],
// },
// CurrentRoad: { // RouteRoad
// RoadName: [ // required
// {
// Language: "STRING_VALUE",
// Value: "STRING_VALUE", // required
// },
// ],
// RouteNumber: [ // required
// {
// Direction: "STRING_VALUE",
// Language: "STRING_VALUE",
// Value: "STRING_VALUE", // required
// },
// ],
// Towards: [ // required
// {
// Language: "STRING_VALUE",
// Value: "STRING_VALUE", // required
// },
// ],
// Type: "STRING_VALUE",
// },
// Distance: Number("long"),
// Duration: Number("long"), // required
// ExitNumber: "<LocalizedStringList>",
// GeometryOffset: Number("int"),
// Instruction: "STRING_VALUE",
// KeepStepDetails: { // RouteKeepStepDetails
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// NextRoad: {
// RoadName: "<LocalizedStringList>", // required
// RouteNumber: [ // required
// {
// Direction: "STRING_VALUE",
// Language: "STRING_VALUE",
// Value: "STRING_VALUE", // required
// },
// ],
// Towards: "<LocalizedStringList>", // required
// Type: "STRING_VALUE",
// },
// RoundaboutEnterStepDetails: { // RouteRoundaboutEnterStepDetails
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// RoundaboutExitStepDetails: { // RouteRoundaboutExitStepDetails
// Intersection: "<LocalizedStringList>", // required
// RelativeExit: Number("int"),
// RoundaboutAngle: Number("double"),
// SteeringDirection: "STRING_VALUE",
// },
// RoundaboutPassStepDetails: { // RouteRoundaboutPassStepDetails
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// Signpost: { // RouteSignpost
// Labels: [ // RouteSignpostLabelList // required
// { // RouteSignpostLabel
// RouteNumber: "<RouteNumber>",
// Text: "<LocalizedString>",
// },
// ],
// },
// TurnStepDetails: { // RouteTurnStepDetails
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// Type: "STRING_VALUE", // required
// },
// ],
// },
// TravelMode: "STRING_VALUE", // required
// Type: "STRING_VALUE", // required
// VehicleLegDetails: { // RouteVehicleLegDetails
// Arrival: { // RouteVehicleArrival
// Place: { // RouteVehiclePlace
// Name: "STRING_VALUE",
// OriginalPosition: "<Position23>",
// Position: "<Position23>", // required
// SideOfStreet: "STRING_VALUE",
// WaypointIndex: Number("int"),
// },
// Time: "STRING_VALUE",
// },
// Departure: { // RouteVehicleDeparture
// Place: {
// Name: "STRING_VALUE",
// OriginalPosition: "<Position23>",
// Position: "<Position23>", // required
// SideOfStreet: "STRING_VALUE",
// WaypointIndex: Number("int"),
// },
// Time: "STRING_VALUE",
// },
// Incidents: [ // RouteVehicleIncidentList // required
// { // RouteVehicleIncident
// Description: "STRING_VALUE",
// EndTime: "STRING_VALUE",
// Severity: "STRING_VALUE",
// StartTime: "STRING_VALUE",
// Type: "STRING_VALUE",
// },
// ],
// Notices: [ // RouteVehicleNoticeList // required
// { // RouteVehicleNotice
// Code: "STRING_VALUE", // required
// Details: [ // RouteVehicleNoticeDetailList // required
// { // RouteVehicleNoticeDetail
// Title: "STRING_VALUE",
// ViolatedConstraints: { // RouteViolatedConstraints
// AllHazardsRestricted: true || false,
// AxleCount: { // RouteNoticeDetailRange
// Min: Number("int"),
// Max: Number("int"),
// },
// HazardousCargos: [ // RouteHazardousCargoTypeList // required
// "STRING_VALUE",
// ],
// MaxHeight: Number("long"),
// MaxKpraLength: Number("long"),
// MaxLength: Number("long"),
// MaxPayloadCapacity: Number("long"),
// MaxWeight: { // RouteWeightConstraint
// Type: "STRING_VALUE", // required
// Value: Number("long"), // required
// },
// MaxWeightPerAxle: Number("long"),
// MaxWeightPerAxleGroup: { // WeightPerAxleGroup
// Single: Number("long"),
// Tandem: Number("long"),
// Triple: Number("long"),
// Quad: Number("long"),
// Quint: Number("long"),
// },
// MaxWidth: Number("long"),
// Occupancy: {
// Min: Number("int"),
// Max: Number("int"),
// },
// RestrictedTimes: "STRING_VALUE",
// TimeDependent: true || false,
// TrailerCount: {
// Min: Number("int"),
// Max: Number("int"),
// },
// TravelMode: true || false,
// TruckRoadType: "STRING_VALUE",
// TruckType: "STRING_VALUE",
// TunnelRestrictionCode: "STRING_VALUE",
// },
// },
// ],
// Impact: "STRING_VALUE",
// },
// ],
// PassThroughWaypoints: [ // required
// {
// GeometryOffset: Number("int"),
// Place: {
// OriginalPosition: "<Position23>",
// Position: "<Position23>", // required
// WaypointIndex: Number("int"),
// },
// },
// ],
// Spans: [ // RouteVehicleSpanList // required
// { // RouteVehicleSpan
// BestCaseDuration: Number("long"),
// CarAccess: [ // RouteSpanCarAccessAttributeList
// "STRING_VALUE",
// ],
// Country: "STRING_VALUE",
// Distance: Number("long"),
// Duration: Number("long"),
// DynamicSpeed: {
// BestCaseSpeed: Number("double"),
// TurnDuration: Number("long"),
// TypicalSpeed: Number("double"),
// },
// FunctionalClassification: Number("int"),
// Gate: "STRING_VALUE",
// GeometryOffset: Number("int"),
// Incidents: [
// Number("int"),
// ],
// Names: "<LocalizedStringList>",
// Notices: [
// Number("int"),
// ],
// RailwayCrossing: "STRING_VALUE",
// Region: "STRING_VALUE",
// RoadAttributes: [
// "STRING_VALUE",
// ],
// RouteNumbers: [
// "<RouteNumber>",
// ],
// ScooterAccess: [ // RouteSpanScooterAccessAttributeList
// "STRING_VALUE",
// ],
// SpeedLimit: {
// MaxSpeed: Number("double"),
// Unlimited: true || false,
// },
// TollSystems: [
// Number("int"),
// ],
// TruckAccess: [ // RouteSpanTruckAccessAttributeList
// "STRING_VALUE",
// ],
// TruckRoadTypes: [
// Number("int"),
// ],
// TypicalDuration: Number("long"),
// Zones: "<IndexList>",
// },
// ],
// Summary: { // RouteVehicleSummary
// Overview: { // RouteVehicleOverviewSummary
// BestCaseDuration: Number("long"),
// Distance: Number("long"), // required
// Duration: Number("long"), // required
// TypicalDuration: Number("long"),
// },
// TravelOnly: { // RouteVehicleTravelOnlySummary
// BestCaseDuration: Number("long"),
// Duration: Number("long"), // required
// TypicalDuration: Number("long"),
// },
// },
// Tolls: [ // RouteTollList // required
// { // RouteToll
// Country: "STRING_VALUE",
// PaymentSites: [ // RouteTollPaymentSiteList // required
// { // RouteTollPaymentSite
// Name: "STRING_VALUE",
// Position: "<Position23>", // required
// },
// ],
// Rates: [ // RouteTollRateList // required
// { // RouteTollRate
// ApplicableTimes: "STRING_VALUE",
// ConvertedPrice: { // RouteTollPrice
// Currency: "STRING_VALUE", // required
// Estimate: true || false, // required
// PerDuration: Number("long"),
// Range: true || false, // required
// RangeValue: { // RouteTollPriceValueRange
// Min: Number("double"), // required
// Max: Number("double"), // required
// },
// Value: Number("double"), // required
// },
// Id: "STRING_VALUE", // required
// LocalPrice: {
// Currency: "STRING_VALUE", // required
// Estimate: true || false, // required
// PerDuration: Number("long"),
// Range: true || false, // required
// RangeValue: {
// Min: Number("double"), // required
// Max: Number("double"), // required
// },
// Value: Number("double"), // required
// },
// Name: "STRING_VALUE", // required
// Pass: { // RouteTollPass
// IncludesReturnTrip: true || false,
// SeniorPass: true || false,
// TransferCount: Number("int"),
// TripCount: Number("int"),
// ValidityPeriod: { // RouteTollPassValidityPeriod
// Period: "STRING_VALUE", // required
// PeriodCount: Number("int"),
// },
// },
// PaymentMethods: [ // RouteTollPaymentMethodList // required
// "STRING_VALUE",
// ],
// Transponders: [ // RouteTransponderList // required
// { // RouteTransponder
// SystemName: "STRING_VALUE",
// },
// ],
// },
// ],
// Systems: "<IndexList>", // required
// },
// ],
// TollSystems: [ // RouteTollSystemList // required
// { // RouteTollSystem
// Name: "STRING_VALUE",
// },
// ],
// TravelSteps: [ // RouteVehicleTravelStepList // required
// { // RouteVehicleTravelStep
// ContinueHighwayStepDetails: { // RouteContinueHighwayStepDetails
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// ContinueStepDetails: {
// Intersection: "<LocalizedStringList>", // required
// },
// CurrentRoad: {
// RoadName: "<LocalizedStringList>", // required
// RouteNumber: [ // required
// "<RouteNumber>",
// ],
// Towards: "<LocalizedStringList>", // required
// Type: "STRING_VALUE",
// },
// Distance: Number("long"),
// Duration: Number("long"), // required
// EnterHighwayStepDetails: { // RouteEnterHighwayStepDetails
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// ExitNumber: "<LocalizedStringList>",
// ExitStepDetails: { // RouteExitStepDetails
// Intersection: "<LocalizedStringList>", // required
// RelativeExit: Number("int"),
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// GeometryOffset: Number("int"),
// Instruction: "STRING_VALUE",
// KeepStepDetails: {
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// NextRoad: {
// RoadName: "<LocalizedStringList>", // required
// RouteNumber: "<RouteNumberList>", // required
// Towards: "<LocalizedStringList>", // required
// Type: "STRING_VALUE",
// },
// RampStepDetails: { // RouteRampStepDetails
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// RoundaboutEnterStepDetails: {
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// RoundaboutExitStepDetails: {
// Intersection: "<LocalizedStringList>", // required
// RelativeExit: Number("int"),
// RoundaboutAngle: Number("double"),
// SteeringDirection: "STRING_VALUE",
// },
// RoundaboutPassStepDetails: {
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// Signpost: {
// Labels: [ // required
// {
// RouteNumber: "<RouteNumber>",
// Text: "<LocalizedString>",
// },
// ],
// },
// TurnStepDetails: {
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// Type: "STRING_VALUE", // required
// UTurnStepDetails: { // RouteUTurnStepDetails
// Intersection: "<LocalizedStringList>", // required
// SteeringDirection: "STRING_VALUE",
// TurnAngle: Number("double"),
// TurnIntensity: "STRING_VALUE",
// },
// },
// ],
// TruckRoadTypes: [ // TruckRoadTypeList // required
// "STRING_VALUE",
// ],
// Zones: [ // RouteZoneList // required
// { // RouteZone
// Category: "STRING_VALUE",
// Name: "STRING_VALUE",
// },
// ],
// },
// },
// ],
// MajorRoadLabels: [ // RouteMajorRoadLabelList // required
// { // RouteMajorRoadLabel
// RoadName: "<LocalizedString>",
// RouteNumber: "<RouteNumber>",
// },
// ],
// Summary: { // RouteSummary
// Distance: Number("long"),
// Duration: Number("long"),
// Tolls: { // RouteTollSummary
// Total: { // RouteTollPriceSummary
// Currency: "STRING_VALUE", // required
// Estimate: true || false, // required
// Range: true || false, // required
// RangeValue: {
// Min: Number("double"), // required
// Max: Number("double"), // required
// },
// Value: Number("double"), // required
// },
// },
// },
// },
// ],
// };
CalculateRoutesCommand Input
See CalculateRoutesCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
DestinationRequired | number[] | undefined | The final position for the route. In the World Geodetic System (WGS 84) format: |
OriginRequired | number[] | undefined | The start position for the route. |
Allow | RouteAllowOptions | undefined | Features that are allowed while calculating a route. |
ArrivalTime | string | undefined | Time of arrival at the destination. Time format: Examples: |
Avoid | RouteAvoidanceOptions | undefined | Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. |
DepartNow | boolean | undefined | Uses the current time as the time of departure. |
DepartureTime | string | undefined | Time of departure from thr origin. Time format: Examples: |
DestinationOptions | RouteDestinationOptions | undefined | Destination related options. |
Driver | RouteDriverOptions | undefined | Driver related options. |
Exclude | RouteExclusionOptions | undefined | Features to be strictly excluded while calculating the route. |
InstructionsMeasurementSystem | MeasurementSystem | undefined | Measurement system to be used for instructions within steps in the response. |
Key | string | undefined | Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. |
Languages | string[] | undefined | List of languages for instructions within steps in the response. Instructions in the requested language are returned only if they are available. |
LegAdditionalFeatures | RouteLegAdditionalFeature[] | undefined | A list of optional additional parameters such as timezone that can be requested for each result.
|
LegGeometryFormat | GeometryFormat | undefined | Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats. |
MaxAlternatives | number | undefined | Maximum number of alternative routes to be provided in the response, if available. |
OptimizeRoutingFor | RoutingObjective | undefined | Specifies the optimization criteria for calculating a route. Default Value: |
OriginOptions | RouteOriginOptions | undefined | Origin related options. |
SpanAdditionalFeatures | RouteSpanAdditionalFeature[] | undefined | A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values. |
Tolls | RouteTollOptions | undefined | Toll related options. |
Traffic | RouteTrafficOptions | undefined | Traffic related options. |
TravelMode | RouteTravelMode | undefined | Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. Default Value: |
TravelModeOptions | RouteTravelModeOptions | undefined | Travel mode related options for the provided travel mode. |
TravelStepType | RouteTravelStepType | undefined | Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system. |
Waypoints | RouteWaypoint[] | undefined | List of waypoints between the Origin and Destination. |
CalculateRoutesCommand Output
See CalculateRoutesCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
LegGeometryFormatRequired | GeometryFormat | undefined | Specifies the format of the geometry returned for each leg of the route. |
NoticesRequired | RouteResponseNotice[] | undefined | Notices are additional information returned that indicate issues that occurred during route calculation. |
PricingBucketRequired | string | undefined | The pricing bucket for which the query is charged at. |
RoutesRequired | Route[] | undefined | The path from the origin to the destination. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You don't have sufficient access to perform this action. |
| InternalServerException | server | The request processing has failed because of an unknown error, exception or failure. |
| ThrottlingException | client | The request was denied due to request throttling. |
| ValidationException | client | The input fails to satisfy the constraints specified by an AWS service. |
| GeoRoutesServiceException | Base exception class for all service exceptions from GeoRoutes service. |