@aws-sdk/client-geo-routes 3.1058.0 → 3.1060.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist-cjs/endpoint/bdd.js +8 -8
- package/dist-cjs/index.js +239 -0
- package/dist-cjs/schemas/schemas_0.js +653 -64
- package/dist-es/endpoint/bdd.js +8 -8
- package/dist-es/models/enums.js +208 -0
- package/dist-es/schemas/schemas_0.js +647 -59
- package/dist-types/GeoRoutes.d.ts +1 -1
- package/dist-types/GeoRoutesClient.d.ts +1 -1
- package/dist-types/commands/CalculateIsolinesCommand.d.ts +14 -14
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +11 -11
- package/dist-types/commands/CalculateRoutesCommand.d.ts +698 -89
- package/dist-types/commands/OptimizeWaypointsCommand.d.ts +9 -9
- package/dist-types/commands/SnapToRoadsCommand.d.ts +3 -3
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/enums.d.ts +456 -0
- package/dist-types/models/models_0.d.ts +1783 -140
- package/dist-types/schemas/schemas_0.d.ts +58 -0
- package/dist-types/ts3.4/models/enums.d.ts +269 -0
- package/dist-types/ts3.4/models/models_0.d.ts +425 -19
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +58 -0
- package/package.json +8 -8
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { DayOfWeek, GeometryFormat, IsolineEngineType, IsolineHazardousCargoType, IsolineOptimizationObjective, IsolineTravelMode, IsolineTruckType, IsolineZoneCategory, MatchingStrategy, MeasurementSystem, RoadSnapHazardousCargoType, RoadSnapNoticeCode, RoadSnapTravelMode, RouteDirection, RouteEngineType, RouteFerryAfterTravelStepType, RouteFerryBeforeTravelStepType, RouteFerryNoticeCode, RouteFerryTravelStepType, RouteHazardousCargoType, RouteLegAdditionalFeature, RouteLegTravelMode, RouteLegType, RouteMatrixErrorCode, RouteMatrixHazardousCargoType, RouteMatrixTravelMode, RouteMatrixTruckType, RouteMatrixZoneCategory, RouteNoticeImpact, RoutePedestrianNoticeCode, RoutePedestrianTravelStepType, RouteResponseNoticeCode, RouteRoadType, RouteSideOfStreet, RouteSpanAdditionalFeature, RouteSpanCarAccessAttribute, RouteSpanGateAttribute, RouteSpanPedestrianAccessAttribute, RouteSpanRailwayCrossingAttribute, RouteSpanRoadAttribute, RouteSpanScooterAccessAttribute, RouteSpanTruckAccessAttribute, RouteSteeringDirection, RouteTollPassValidityPeriodType, RouteTollPaymentMethod, RouteTollVehicleCategory, RouteTravelMode, RouteTravelStepType, RouteTruckType, RouteTurnIntensity, RouteVehicleIncidentSeverity, RouteVehicleIncidentType, RouteVehicleNoticeCode, RouteVehicleTravelStepType, RouteWeightConstraintType, RouteZoneCategory, RoutingObjective, SideOfStreetMatchingStrategy, TrafficUsage, WaypointOptimizationClusteringAlgorithm, WaypointOptimizationConstraint, WaypointOptimizationHazardousCargoType, WaypointOptimizationSequencingObjective, WaypointOptimizationServiceTimeTreatment, WaypointOptimizationTravelMode, WaypointOptimizationTruckType } from "./enums";
|
|
1
|
+
import type { DayOfWeek, GeometryFormat, IsolineEngineType, IsolineHazardousCargoType, IsolineOptimizationObjective, IsolineTravelMode, IsolineTruckType, IsolineZoneCategory, MatchingStrategy, MeasurementSystem, RoadSnapHazardousCargoType, RoadSnapNoticeCode, RoadSnapTravelMode, RouteAccessibilityAttribute, RouteAccessibilityAvailability, RouteAttributionType, RouteDirection, RouteEngineType, RouteFerryAfterTravelStepType, RouteFerryBeforeTravelStepType, RouteFerryNoticeCode, RouteFerryTravelStepType, RouteHazardousCargoType, RouteIntermodalEnabledLegs, RouteLegAdditionalFeature, RouteLegTravelMode, RouteLegType, RouteMatrixErrorCode, RouteMatrixHazardousCargoType, RouteMatrixTravelMode, RouteMatrixTruckType, RouteMatrixZoneCategory, RouteNoticeImpact, RoutePedestrianAfterTravelStepType, RoutePedestrianNoticeCode, RoutePedestrianPlaceType, RoutePedestrianTravelStepType, RouteRentalAfterTravelStepType, RouteRentalBeforeTravelStepType, RouteRentalMode, RouteRentalPlaceType, RouteRentalTravelStepType, RouteResponseNoticeCode, RouteRoadType, RouteSideOfStreet, RouteSpanAdditionalFeature, RouteSpanCarAccessAttribute, RouteSpanGateAttribute, RouteSpanPedestrianAccessAttribute, RouteSpanRailwayCrossingAttribute, RouteSpanRoadAttribute, RouteSpanScooterAccessAttribute, RouteSpanTruckAccessAttribute, RouteSteeringDirection, RouteTaxiAfterTravelStepType, RouteTaxiBeforeTravelStepType, RouteTaxiMode, RouteTaxiNoticeCode, RouteTaxiPlaceType, RouteTaxiTravelStepType, RouteTollPassValidityPeriodType, RouteTollPaymentMethod, RouteTollVehicleCategory, RouteTransitAfterTravelStepType, RouteTransitBeforeTravelStepType, RouteTransitIncidentEffect, RouteTransitIncidentType, RouteTransitIntermediateStopAttribute, RouteTransitMode, RouteTransitNoticeCode, RouteTransitPlaceType, RouteTransitTravelStepType, RouteTransitTripStatus, RouteTravelMode, RouteTravelStepType, RouteTruckType, RouteTurnIntensity, RouteVehicleAfterTravelStepType, RouteVehicleIncidentSeverity, RouteVehicleIncidentType, RouteVehicleMode, RouteVehicleNoticeCode, RouteVehiclePlaceType, RouteVehicleTravelStepType, RouteWebLinkDeviceType, RouteWeightConstraintType, RouteZoneCategory, RoutingObjective, SideOfStreetMatchingStrategy, TrafficUsage, WaypointOptimizationClusteringAlgorithm, WaypointOptimizationConstraint, WaypointOptimizationHazardousCargoType, WaypointOptimizationSequencingObjective, WaypointOptimizationServiceTimeTreatment, WaypointOptimizationTravelMode, WaypointOptimizationTruckType } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>Special road types or features that should be considered available for routing. For example, this attribute can be used to allow the use of HOV (high-occupancy vehicle) or HOT (high-occupancy toll) lanes, even if they would otherwise not be.</p>
|
|
4
4
|
* @public
|
|
@@ -1033,23 +1033,23 @@ export interface RouteMatrixOrigin {
|
|
|
1033
1033
|
Position: number[] | undefined;
|
|
1034
1034
|
}
|
|
1035
1035
|
/**
|
|
1036
|
-
* <p>
|
|
1036
|
+
* <p> <code>AutoCircle</code> requests the route matrix service to define a <code>Circle</code> boundary that best attempts to include most waypoints (<code>Origins</code> and <code>Destinations</code>) using the <code>AutoCircle</code> settings. Any waypoints outside of the auto-defined <code>Circle</code> boundary will be considered out of the routing boundary, which results in a route matrix entry error.</p> <p> <code>AutoCircle</code> is only used in the request to configure a <code>Circle</code> for the route calculation. The derived <code>Circle</code> will also be provided in the response.</p>
|
|
1037
1037
|
* @public
|
|
1038
1038
|
*/
|
|
1039
1039
|
export interface RouteMatrixAutoCircle {
|
|
1040
1040
|
/**
|
|
1041
|
-
* <p>The
|
|
1041
|
+
* <p>The minimal distance, in meters, between any waypoint and the perimeter of the circle auto-defined for the boundary. Some margin is usually recommended so that the routing has enough leeway to travel from one waypoint to another optimally without conflicting with the routing boundary.</p> <p>The total of <code>MaxRadius</code> and <code>Margin</code> must be less than or equal to 200,000 meters.</p>
|
|
1042
1042
|
* @public
|
|
1043
1043
|
*/
|
|
1044
1044
|
Margin?: number | undefined;
|
|
1045
1045
|
/**
|
|
1046
|
-
* <p>The maximum
|
|
1046
|
+
* <p>The maximum radius, in meters, that the auto-defined <code>Circle</code> boundary should have, before the <code>Margin</code> distance is added to the circle.</p> <p>The total of <code>MaxRadius</code> and <code>Margin</code> must be less than or equal to 200,000 meters.</p>
|
|
1047
1047
|
* @public
|
|
1048
1048
|
*/
|
|
1049
1049
|
MaxRadius?: number | undefined;
|
|
1050
1050
|
}
|
|
1051
1051
|
/**
|
|
1052
|
-
* <p>Geometry defined as a circle.
|
|
1052
|
+
* <p>Geometry defined as a circle. The circle defines the routing boundary area. Any waypoints outside the circle will result in a route matrix entry error.</p> <p>You can specify a <code>Circle</code> directly in the request, or it will be auto-derived when <code>AutoCircle</code> is used. When <code>AutoCircle</code> is set in the request, the response routing boundary will return <code>Circle</code> derived from the <code>AutoCircle</code> settings.</p>
|
|
1053
1053
|
* @public
|
|
1054
1054
|
*/
|
|
1055
1055
|
export interface Circle {
|
|
@@ -1059,7 +1059,7 @@ export interface Circle {
|
|
|
1059
1059
|
*/
|
|
1060
1060
|
Center: number[] | undefined;
|
|
1061
1061
|
/**
|
|
1062
|
-
* <p>Radius of the Circle.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
1062
|
+
* <p>Radius of the Circle.</p> <p> <b>Unit</b>: <code>meters</code> </p> <p>Valid Range: Minimum value of 0. Maximum value of 200000.</p>
|
|
1063
1063
|
* @public
|
|
1064
1064
|
*/
|
|
1065
1065
|
Radius: number | undefined;
|
|
@@ -1070,22 +1070,22 @@ export interface Circle {
|
|
|
1070
1070
|
*/
|
|
1071
1071
|
export interface RouteMatrixBoundaryGeometry {
|
|
1072
1072
|
/**
|
|
1073
|
-
* <p>
|
|
1073
|
+
* <p> <code>AutoCircle</code> requests the route matrix service to define a <code>Circle</code> boundary that best attempts to include most waypoints (<code>Origins</code> and <code>Destinations</code>) using the <code>AutoCircle</code> settings. Any waypoints outside of the auto-defined <code>Circle</code> boundary will be considered out of the routing boundary, which results in a route matrix entry error.</p> <p> <code>AutoCircle</code> is only used in the request to configure a <code>Circle</code> for the route calculation. The derived <code>Circle</code> will also be provided in the response.</p>
|
|
1074
1074
|
* @public
|
|
1075
1075
|
*/
|
|
1076
1076
|
AutoCircle?: RouteMatrixAutoCircle | undefined;
|
|
1077
1077
|
/**
|
|
1078
|
-
* <p>Geometry defined as a circle.
|
|
1078
|
+
* <p>Geometry defined as a circle. The circle defines the routing boundary area. Any waypoints outside the circle will result in a route matrix entry error.</p> <p>You can specify a <code>Circle</code> directly in the request, or it will be auto-derived when <code>AutoCircle</code> is used. When <code>AutoCircle</code> is set in the request, the response routing boundary will return <code>Circle</code> derived from the <code>AutoCircle</code> settings.</p>
|
|
1079
1079
|
* @public
|
|
1080
1080
|
*/
|
|
1081
1081
|
Circle?: Circle | undefined;
|
|
1082
1082
|
/**
|
|
1083
|
-
* <p>Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.</p>
|
|
1083
|
+
* <p>Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.</p> <p>Diagonal distance of the bounding box must be less than or equal to 400,000 meters.</p>
|
|
1084
1084
|
* @public
|
|
1085
1085
|
*/
|
|
1086
1086
|
BoundingBox?: number[] | undefined;
|
|
1087
1087
|
/**
|
|
1088
|
-
* <p>Geometry defined as a polygon with only one linear ring.</p>
|
|
1088
|
+
* <p>Geometry defined as a polygon with only one linear ring. A linear ring is a closed sequence of four or more coordinates. The first and last coordinates are the same, forming a closed boundary. Each coordinate is a position in [longitude, latitude] format.</p> <p>The structure is an array of linear rings (only 1 allowed). Each linear ring is an array of coordinates (minimum 4), and each coordinate is an array of two doubles [longitude, latitude].</p> <p>Maximum distance between any two vertices must be less than or equal to 400,000 meters.</p>
|
|
1089
1089
|
* @public
|
|
1090
1090
|
*/
|
|
1091
1091
|
Polygon?: number[][][] | undefined;
|
|
@@ -1318,7 +1318,7 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1318
1318
|
*/
|
|
1319
1319
|
DepartureTime?: string | undefined;
|
|
1320
1320
|
/**
|
|
1321
|
-
* <p>List of destinations for the route.</p> <note> <p>Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html">Routes pricing</a> in the <i>Amazon Location Service Developer Guide</i>.</p> </note>
|
|
1321
|
+
* <p>List of destinations for the route in World Geodetic System (WGS 84) format: [longitude, latitude].</p> <note> <p>Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html">Routes pricing</a> in the <i>Amazon Location Service Developer Guide</i>.</p> </note> <p>The maximum number of destinations depends on the routing boundary configuration:</p> <ul> <li> <p>With <code>RoutingBoundary.Geometry</code> set: maximum 500 destinations</p> </li> <li> <p>With <code>RoutingBoundary.Unbounded</code> set to <code>true</code>: maximum 100 destinations</p> </li> <li> <p>For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers in <code>ap-southeast-1</code> and <code>ap-southeast-5</code>: maximum 350 destinations</p> </li> </ul> <p>The total matrix size (origins × destinations) must not exceed:</p> <ul> <li> <p>With <code>RoutingBoundary.Geometry</code>: 160,000</p> </li> <li> <p>With <code>RoutingBoundary.Unbounded</code>: 100</p> </li> <li> <p>For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers in <code>ap-southeast-1</code> and <code>ap-southeast-5</code>: 122,500</p> </li> </ul>
|
|
1322
1322
|
* @public
|
|
1323
1323
|
*/
|
|
1324
1324
|
Destinations: RouteMatrixDestination[] | undefined;
|
|
@@ -1338,12 +1338,12 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1338
1338
|
*/
|
|
1339
1339
|
OptimizeRoutingFor?: RoutingObjective | undefined;
|
|
1340
1340
|
/**
|
|
1341
|
-
* <p>
|
|
1341
|
+
* <p>List of origins for the route in World Geodetic System (WGS 84) format: [longitude, latitude].</p> <note> <p>Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html">Routes pricing</a> in the <i>Amazon Location Service Developer Guide</i>.</p> </note> <p>The maximum number of origins depends on the routing boundary configuration:</p> <ul> <li> <p>With <code>RoutingBoundary.Geometry</code> set: maximum 500 origins</p> </li> <li> <p>With <code>RoutingBoundary.Unbounded</code> set to <code>true</code>: maximum 15 origins</p> </li> <li> <p>For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers in <code>ap-southeast-1</code> and <code>ap-southeast-5</code>: maximum 350 origins</p> </li> </ul> <p>The total matrix size (origins × destinations) must not exceed:</p> <ul> <li> <p>With <code>RoutingBoundary.Geometry</code>: 160,000</p> </li> <li> <p>With <code>RoutingBoundary.Unbounded</code>: 100</p> </li> <li> <p>For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers in <code>ap-southeast-1</code> and <code>ap-southeast-5</code>: 122,500</p> </li> </ul>
|
|
1342
1342
|
* @public
|
|
1343
1343
|
*/
|
|
1344
1344
|
Origins: RouteMatrixOrigin[] | undefined;
|
|
1345
1345
|
/**
|
|
1346
|
-
* <p> Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>Unbounded</code> set to <code>true</code>. </p> <p>Default value: <code>Unbounded set to true</code> </p> <note> <p>When
|
|
1346
|
+
* <p> Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>Unbounded</code> set to <code>true</code>. </p> <p>Default value: <code>Unbounded set to true</code> </p> <note> <p>When <code>AutoCircle</code> is set in the request, the response routing boundary will return <code>Circle</code> derived from the <code>AutoCircle</code> settings.</p> </note>
|
|
1347
1347
|
* @public
|
|
1348
1348
|
*/
|
|
1349
1349
|
RoutingBoundary?: RouteMatrixBoundary | undefined;
|
|
@@ -1404,7 +1404,7 @@ export interface CalculateRouteMatrixResponse {
|
|
|
1404
1404
|
*/
|
|
1405
1405
|
RouteMatrix: RouteMatrixEntry[][] | undefined;
|
|
1406
1406
|
/**
|
|
1407
|
-
* <p>Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.</p> <note> <p>When
|
|
1407
|
+
* <p>Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.</p> <note> <p>When <code>AutoCircle</code> is set in the request, the response routing boundary will return <code>Circle</code> derived from the <code>AutoCircle</code> settings.</p> </note>
|
|
1408
1408
|
* @public
|
|
1409
1409
|
*/
|
|
1410
1410
|
RoutingBoundary: RouteMatrixBoundary | undefined;
|
|
@@ -1796,6 +1796,147 @@ export interface RouteCarOptions {
|
|
|
1796
1796
|
*/
|
|
1797
1797
|
Occupancy?: number | undefined;
|
|
1798
1798
|
}
|
|
1799
|
+
/**
|
|
1800
|
+
* <p>Options for the pedestrian leg of the intermodal route.</p>
|
|
1801
|
+
* @public
|
|
1802
|
+
*/
|
|
1803
|
+
export interface RouteIntermodalPedestrianOptions {
|
|
1804
|
+
/**
|
|
1805
|
+
* <p>Maximum walking distance allowed.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
1806
|
+
* @public
|
|
1807
|
+
*/
|
|
1808
|
+
MaxDistance?: number | undefined;
|
|
1809
|
+
/**
|
|
1810
|
+
* <p>Walking speed.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
1811
|
+
* @public
|
|
1812
|
+
*/
|
|
1813
|
+
Speed?: number | undefined;
|
|
1814
|
+
}
|
|
1815
|
+
/**
|
|
1816
|
+
* <p>Options for the rental leg of the intermodal route.</p>
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
export interface RouteIntermodalRentalOptions {
|
|
1820
|
+
/**
|
|
1821
|
+
* <p>Allowed rental transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>ExcludedModes</code>.</p>
|
|
1822
|
+
* @public
|
|
1823
|
+
*/
|
|
1824
|
+
AllowedModes?: RouteRentalMode[] | undefined;
|
|
1825
|
+
/**
|
|
1826
|
+
* <p>Specifies the portion of the route for which this leg type is enabled. By default, the leg type is enabled for all legs. Valid values:</p> <ul> <li> <p> <code>FirstLeg</code> - Enable this leg type for the first non-pedestrian leg of the route.</p> </li> <li> <p> <code>LastLeg</code> - Enable this leg type for the last non-pedestrian leg of the route.</p> </li> <li> <p> <code>EntireRoute</code> - Enable this leg type for the entire route.</p> </li> <li> <p> <code>None</code> - Disable this leg type entirely.</p> </li> </ul>
|
|
1827
|
+
* @public
|
|
1828
|
+
*/
|
|
1829
|
+
EnabledFor?: RouteIntermodalEnabledLegs[] | undefined;
|
|
1830
|
+
/**
|
|
1831
|
+
* <p>Excluded rental transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>AllowedModes</code>.</p>
|
|
1832
|
+
* @public
|
|
1833
|
+
*/
|
|
1834
|
+
ExcludedModes?: RouteRentalMode[] | undefined;
|
|
1835
|
+
}
|
|
1836
|
+
/**
|
|
1837
|
+
* <p>Options for the taxi leg of the intermodal route.</p>
|
|
1838
|
+
* @public
|
|
1839
|
+
*/
|
|
1840
|
+
export interface RouteIntermodalTaxiOptions {
|
|
1841
|
+
/**
|
|
1842
|
+
* <p>Allowed taxi transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>ExcludedModes</code>.</p>
|
|
1843
|
+
* @public
|
|
1844
|
+
*/
|
|
1845
|
+
AllowedModes?: RouteTaxiMode[] | undefined;
|
|
1846
|
+
/**
|
|
1847
|
+
* <p>Specifies the portion of the route for which this leg type is enabled. By default, the leg type is enabled for all legs. Valid values:</p> <ul> <li> <p> <code>FirstLeg</code> - Enable this leg type for the first non-pedestrian leg of the route.</p> </li> <li> <p> <code>LastLeg</code> - Enable this leg type for the last non-pedestrian leg of the route.</p> </li> <li> <p> <code>EntireRoute</code> - Enable this leg type for the entire route.</p> </li> <li> <p> <code>None</code> - Disable this leg type entirely.</p> </li> </ul>
|
|
1848
|
+
* @public
|
|
1849
|
+
*/
|
|
1850
|
+
EnabledFor?: RouteIntermodalEnabledLegs[] | undefined;
|
|
1851
|
+
/**
|
|
1852
|
+
* <p>Excluded taxi transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>AllowedModes</code>.</p>
|
|
1853
|
+
* @public
|
|
1854
|
+
*/
|
|
1855
|
+
ExcludedModes?: RouteTaxiMode[] | undefined;
|
|
1856
|
+
}
|
|
1857
|
+
/**
|
|
1858
|
+
* <p>Options for the transit leg of the intermodal route.</p>
|
|
1859
|
+
* @public
|
|
1860
|
+
*/
|
|
1861
|
+
export interface RouteIntermodalTransitOptions {
|
|
1862
|
+
/**
|
|
1863
|
+
* <p>Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>ExcludedModes</code>.</p>
|
|
1864
|
+
* @public
|
|
1865
|
+
*/
|
|
1866
|
+
AllowedModes?: RouteTransitMode[] | undefined;
|
|
1867
|
+
/**
|
|
1868
|
+
* <p>Specifies the portion of the route for which this leg type is enabled. By default, the leg type is enabled for all legs. Valid values:</p> <ul> <li> <p> <code>FirstLeg</code> - Enable this leg type for the first non-pedestrian leg of the route.</p> </li> <li> <p> <code>LastLeg</code> - Enable this leg type for the last non-pedestrian leg of the route.</p> </li> <li> <p> <code>EntireRoute</code> - Enable this leg type for the entire route.</p> </li> <li> <p> <code>None</code> - Disable this leg type entirely.</p> </li> </ul>
|
|
1869
|
+
* @public
|
|
1870
|
+
*/
|
|
1871
|
+
EnabledFor?: RouteIntermodalEnabledLegs[] | undefined;
|
|
1872
|
+
/**
|
|
1873
|
+
* <p>Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>AllowedModes</code>.</p>
|
|
1874
|
+
* @public
|
|
1875
|
+
*/
|
|
1876
|
+
ExcludedModes?: RouteTransitMode[] | undefined;
|
|
1877
|
+
}
|
|
1878
|
+
/**
|
|
1879
|
+
* <p>Options for the vehicle leg of the intermodal route.</p>
|
|
1880
|
+
* @public
|
|
1881
|
+
*/
|
|
1882
|
+
export interface RouteIntermodalVehicleOptions {
|
|
1883
|
+
/**
|
|
1884
|
+
* <p>Allowed vehicle transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>ExcludedModes</code>.</p>
|
|
1885
|
+
* @public
|
|
1886
|
+
*/
|
|
1887
|
+
AllowedModes?: RouteVehicleMode[] | undefined;
|
|
1888
|
+
/**
|
|
1889
|
+
* <p>Specifies the portion of the route for which this leg type is enabled. By default, the leg type is enabled for all legs. Valid values:</p> <ul> <li> <p> <code>FirstLeg</code> - Enable this leg type for the first non-pedestrian leg of the route.</p> </li> <li> <p> <code>LastLeg</code> - Enable this leg type for the last non-pedestrian leg of the route.</p> </li> <li> <p> <code>EntireRoute</code> - Enable this leg type for the entire route.</p> </li> <li> <p> <code>None</code> - Disable this leg type entirely.</p> </li> </ul>
|
|
1890
|
+
* @public
|
|
1891
|
+
*/
|
|
1892
|
+
EnabledFor?: RouteIntermodalEnabledLegs[] | undefined;
|
|
1893
|
+
/**
|
|
1894
|
+
* <p>Excluded vehicle transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>AllowedModes</code>.</p>
|
|
1895
|
+
* @public
|
|
1896
|
+
*/
|
|
1897
|
+
ExcludedModes?: RouteVehicleMode[] | undefined;
|
|
1898
|
+
}
|
|
1899
|
+
/**
|
|
1900
|
+
* <p>Options related to intermodal routing.</p> <note> <p>Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p> </note>
|
|
1901
|
+
* @public
|
|
1902
|
+
*/
|
|
1903
|
+
export interface RouteIntermodalOptions {
|
|
1904
|
+
/**
|
|
1905
|
+
* <p>Accessibility attributes to consider when calculating the route.</p>
|
|
1906
|
+
* @public
|
|
1907
|
+
*/
|
|
1908
|
+
AccessibilityAttributes?: RouteAccessibilityAttribute[] | undefined;
|
|
1909
|
+
/**
|
|
1910
|
+
* <p>Maximum number of transfers allowed when calculating the route.</p>
|
|
1911
|
+
* @public
|
|
1912
|
+
*/
|
|
1913
|
+
MaxTransfers?: number | undefined;
|
|
1914
|
+
/**
|
|
1915
|
+
* <p>Options for the pedestrian leg of the intermodal route.</p>
|
|
1916
|
+
* @public
|
|
1917
|
+
*/
|
|
1918
|
+
Pedestrian?: RouteIntermodalPedestrianOptions | undefined;
|
|
1919
|
+
/**
|
|
1920
|
+
* <p>Options for the rental leg of the intermodal route.</p>
|
|
1921
|
+
* @public
|
|
1922
|
+
*/
|
|
1923
|
+
Rental?: RouteIntermodalRentalOptions | undefined;
|
|
1924
|
+
/**
|
|
1925
|
+
* <p>Options for the taxi leg of the intermodal route.</p>
|
|
1926
|
+
* @public
|
|
1927
|
+
*/
|
|
1928
|
+
Taxi?: RouteIntermodalTaxiOptions | undefined;
|
|
1929
|
+
/**
|
|
1930
|
+
* <p>Options for the transit leg of the intermodal route.</p>
|
|
1931
|
+
* @public
|
|
1932
|
+
*/
|
|
1933
|
+
Transit?: RouteIntermodalTransitOptions | undefined;
|
|
1934
|
+
/**
|
|
1935
|
+
* <p>Options for the vehicle leg of the intermodal route.</p>
|
|
1936
|
+
* @public
|
|
1937
|
+
*/
|
|
1938
|
+
Vehicle?: RouteIntermodalVehicleOptions | undefined;
|
|
1939
|
+
}
|
|
1799
1940
|
/**
|
|
1800
1941
|
* <p> Options related to the pedestrian. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1801
1942
|
* @public
|
|
@@ -1833,6 +1974,53 @@ export interface RouteScooterOptions {
|
|
|
1833
1974
|
*/
|
|
1834
1975
|
Occupancy?: number | undefined;
|
|
1835
1976
|
}
|
|
1977
|
+
/**
|
|
1978
|
+
* <p>Options for the pedestrian leg of the transit route.</p>
|
|
1979
|
+
* @public
|
|
1980
|
+
*/
|
|
1981
|
+
export interface RouteTransitPedestrianOptions {
|
|
1982
|
+
/**
|
|
1983
|
+
* <p>Maximum walking distance allowed.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
1984
|
+
* @public
|
|
1985
|
+
*/
|
|
1986
|
+
MaxDistance?: number | undefined;
|
|
1987
|
+
/**
|
|
1988
|
+
* <p>Walking speed.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
1989
|
+
* @public
|
|
1990
|
+
*/
|
|
1991
|
+
Speed?: number | undefined;
|
|
1992
|
+
}
|
|
1993
|
+
/**
|
|
1994
|
+
* <p>Options related to transit routing.</p> <note> <p>Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p> </note>
|
|
1995
|
+
* @public
|
|
1996
|
+
*/
|
|
1997
|
+
export interface RouteTransitOptions {
|
|
1998
|
+
/**
|
|
1999
|
+
* <p>Accessibility attributes to consider when calculating the route.</p>
|
|
2000
|
+
* @public
|
|
2001
|
+
*/
|
|
2002
|
+
AccessibilityAttributes?: RouteAccessibilityAttribute[] | undefined;
|
|
2003
|
+
/**
|
|
2004
|
+
* <p>Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>ExcludedModes</code>.</p>
|
|
2005
|
+
* @public
|
|
2006
|
+
*/
|
|
2007
|
+
AllowedModes?: RouteTransitMode[] | undefined;
|
|
2008
|
+
/**
|
|
2009
|
+
* <p>Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>AllowedModes</code>.</p>
|
|
2010
|
+
* @public
|
|
2011
|
+
*/
|
|
2012
|
+
ExcludedModes?: RouteTransitMode[] | undefined;
|
|
2013
|
+
/**
|
|
2014
|
+
* <p>Maximum number of transfers allowed when calculating the route.</p>
|
|
2015
|
+
* @public
|
|
2016
|
+
*/
|
|
2017
|
+
MaxTransfers?: number | undefined;
|
|
2018
|
+
/**
|
|
2019
|
+
* <p>Options for the pedestrian leg of the transit route.</p>
|
|
2020
|
+
* @public
|
|
2021
|
+
*/
|
|
2022
|
+
Pedestrian?: RouteTransitPedestrianOptions | undefined;
|
|
2023
|
+
}
|
|
1836
2024
|
/**
|
|
1837
2025
|
* <p>Trailer options corresponding to the vehicle.</p>
|
|
1838
2026
|
* @public
|
|
@@ -1975,6 +2163,16 @@ export interface RouteTravelModeOptions {
|
|
|
1975
2163
|
* @public
|
|
1976
2164
|
*/
|
|
1977
2165
|
Truck?: RouteTruckOptions | undefined;
|
|
2166
|
+
/**
|
|
2167
|
+
* <p>Travel mode options when the provided travel mode is <code>Intermodal</code>.</p> <note> <p>Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p> </note>
|
|
2168
|
+
* @public
|
|
2169
|
+
*/
|
|
2170
|
+
Intermodal?: RouteIntermodalOptions | undefined;
|
|
2171
|
+
/**
|
|
2172
|
+
* <p>Travel mode options when the provided travel mode is <code>Transit</code>.</p> <note> <p>Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p> </note>
|
|
2173
|
+
* @public
|
|
2174
|
+
*/
|
|
2175
|
+
Transit?: RouteTransitOptions | undefined;
|
|
1978
2176
|
}
|
|
1979
2177
|
/**
|
|
1980
2178
|
* <p>Waypoint between the Origin and Destination.</p>
|
|
@@ -2221,12 +2419,12 @@ export interface RouteFerryPlace {
|
|
|
2221
2419
|
*/
|
|
2222
2420
|
export interface RouteFerryArrival {
|
|
2223
2421
|
/**
|
|
2224
|
-
* <p>
|
|
2422
|
+
* <p>Place details corresponding to the arrival.</p>
|
|
2225
2423
|
* @public
|
|
2226
2424
|
*/
|
|
2227
2425
|
Place: RouteFerryPlace | undefined;
|
|
2228
2426
|
/**
|
|
2229
|
-
* <p>The time.</p>
|
|
2427
|
+
* <p>The arrival time.</p>
|
|
2230
2428
|
* @public
|
|
2231
2429
|
*/
|
|
2232
2430
|
Time?: string | undefined;
|
|
@@ -2258,12 +2456,12 @@ export interface RouteFerryBeforeTravelStep {
|
|
|
2258
2456
|
*/
|
|
2259
2457
|
export interface RouteFerryDeparture {
|
|
2260
2458
|
/**
|
|
2261
|
-
* <p>
|
|
2459
|
+
* <p>Place details corresponding to the departure.</p>
|
|
2262
2460
|
* @public
|
|
2263
2461
|
*/
|
|
2264
2462
|
Place: RouteFerryPlace | undefined;
|
|
2265
2463
|
/**
|
|
2266
|
-
* <p>The time.</p>
|
|
2464
|
+
* <p>The departure time.</p>
|
|
2267
2465
|
* @public
|
|
2268
2466
|
*/
|
|
2269
2467
|
Time?: string | undefined;
|
|
@@ -2316,7 +2514,7 @@ export interface RoutePassThroughWaypoint {
|
|
|
2316
2514
|
*/
|
|
2317
2515
|
GeometryOffset?: number | undefined;
|
|
2318
2516
|
/**
|
|
2319
|
-
* <p>
|
|
2517
|
+
* <p>Place details corresponding to the pass-through waypoint.</p>
|
|
2320
2518
|
* @public
|
|
2321
2519
|
*/
|
|
2322
2520
|
Place: RoutePassThroughPlace | undefined;
|
|
@@ -2363,7 +2561,7 @@ export interface RouteFerrySpan {
|
|
|
2363
2561
|
*/
|
|
2364
2562
|
GeometryOffset?: number | undefined;
|
|
2365
2563
|
/**
|
|
2366
|
-
* <p>
|
|
2564
|
+
* <p>Names of the ferry span in available languages.</p>
|
|
2367
2565
|
* @public
|
|
2368
2566
|
*/
|
|
2369
2567
|
Names?: LocalizedString[] | undefined;
|
|
@@ -2374,17 +2572,17 @@ export interface RouteFerrySpan {
|
|
|
2374
2572
|
Region?: string | undefined;
|
|
2375
2573
|
}
|
|
2376
2574
|
/**
|
|
2377
|
-
* <p>
|
|
2575
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
2378
2576
|
* @public
|
|
2379
2577
|
*/
|
|
2380
2578
|
export interface RouteFerryOverviewSummary {
|
|
2381
2579
|
/**
|
|
2382
|
-
* <p>Distance of the
|
|
2580
|
+
* <p>Distance of the entire leg.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
2383
2581
|
* @public
|
|
2384
2582
|
*/
|
|
2385
2583
|
Distance: number | undefined;
|
|
2386
2584
|
/**
|
|
2387
|
-
* <p>Duration of the
|
|
2585
|
+
* <p>Duration of the entire leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
2388
2586
|
* @public
|
|
2389
2587
|
*/
|
|
2390
2588
|
Duration: number | undefined;
|
|
@@ -2519,11 +2717,80 @@ export interface RouteLegGeometry {
|
|
|
2519
2717
|
*/
|
|
2520
2718
|
Polyline?: string | undefined;
|
|
2521
2719
|
}
|
|
2720
|
+
/**
|
|
2721
|
+
* <p>Steps of a leg that must be performed after the travel portion of the leg.</p>
|
|
2722
|
+
* @public
|
|
2723
|
+
*/
|
|
2724
|
+
export interface RoutePedestrianAfterTravelStep {
|
|
2725
|
+
/**
|
|
2726
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
2727
|
+
* @public
|
|
2728
|
+
*/
|
|
2729
|
+
Duration: number | undefined;
|
|
2730
|
+
/**
|
|
2731
|
+
* <p>Brief description of the step in the requested language.</p> <note> <p>Only available when the TravelStepType is Default.</p> </note>
|
|
2732
|
+
* @public
|
|
2733
|
+
*/
|
|
2734
|
+
Instruction?: string | undefined;
|
|
2735
|
+
/**
|
|
2736
|
+
* <p>Type of the step.</p>
|
|
2737
|
+
* @public
|
|
2738
|
+
*/
|
|
2739
|
+
Type: RoutePedestrianAfterTravelStepType | undefined;
|
|
2740
|
+
}
|
|
2741
|
+
/**
|
|
2742
|
+
* <p>Details about the availability of accessibility features.</p>
|
|
2743
|
+
* @public
|
|
2744
|
+
*/
|
|
2745
|
+
export interface RouteAccessibilityAvailabilityDetails {
|
|
2746
|
+
/**
|
|
2747
|
+
* <p>Wheelchair accessibility status.</p>
|
|
2748
|
+
* @public
|
|
2749
|
+
*/
|
|
2750
|
+
Wheelchair?: RouteAccessibilityAvailability | undefined;
|
|
2751
|
+
}
|
|
2752
|
+
/**
|
|
2753
|
+
* <p>Details of the access point.</p>
|
|
2754
|
+
* @public
|
|
2755
|
+
*/
|
|
2756
|
+
export interface RouteAccessPointDetails {
|
|
2757
|
+
/**
|
|
2758
|
+
* <p>Wheelchair accessibility information for the access point.</p>
|
|
2759
|
+
* @public
|
|
2760
|
+
*/
|
|
2761
|
+
Accessibility?: RouteAccessibilityAvailabilityDetails | undefined;
|
|
2762
|
+
}
|
|
2763
|
+
/**
|
|
2764
|
+
* <p>Details about the station.</p>
|
|
2765
|
+
* @public
|
|
2766
|
+
*/
|
|
2767
|
+
export interface RouteStationDetails {
|
|
2768
|
+
/**
|
|
2769
|
+
* <p>Wheelchair accessibility information for the station.</p>
|
|
2770
|
+
* @public
|
|
2771
|
+
*/
|
|
2772
|
+
Accessibility?: RouteAccessibilityAvailabilityDetails | undefined;
|
|
2773
|
+
/**
|
|
2774
|
+
* <p>Platform name or number.</p>
|
|
2775
|
+
* @public
|
|
2776
|
+
*/
|
|
2777
|
+
PlatformName?: string | undefined;
|
|
2778
|
+
/**
|
|
2779
|
+
* <p>Short text or a number that identifies the station.</p>
|
|
2780
|
+
* @public
|
|
2781
|
+
*/
|
|
2782
|
+
ShortName?: string | undefined;
|
|
2783
|
+
}
|
|
2522
2784
|
/**
|
|
2523
2785
|
* <p>Place details corresponding to the arrival or departure.</p>
|
|
2524
2786
|
* @public
|
|
2525
2787
|
*/
|
|
2526
2788
|
export interface RoutePedestrianPlace {
|
|
2789
|
+
/**
|
|
2790
|
+
* <p>Details of the access point.</p>
|
|
2791
|
+
* @public
|
|
2792
|
+
*/
|
|
2793
|
+
AccessPointDetails?: RouteAccessPointDetails | undefined;
|
|
2527
2794
|
/**
|
|
2528
2795
|
* <p>The name of the place.</p>
|
|
2529
2796
|
* @public
|
|
@@ -2544,6 +2811,16 @@ export interface RoutePedestrianPlace {
|
|
|
2544
2811
|
* @public
|
|
2545
2812
|
*/
|
|
2546
2813
|
SideOfStreet?: RouteSideOfStreet | undefined;
|
|
2814
|
+
/**
|
|
2815
|
+
* <p>Details about the station.</p>
|
|
2816
|
+
* @public
|
|
2817
|
+
*/
|
|
2818
|
+
StationDetails?: RouteStationDetails | undefined;
|
|
2819
|
+
/**
|
|
2820
|
+
* <p>The type of the place.</p>
|
|
2821
|
+
* @public
|
|
2822
|
+
*/
|
|
2823
|
+
Type?: RoutePedestrianPlaceType | undefined;
|
|
2547
2824
|
/**
|
|
2548
2825
|
* <p>Index of the waypoint in the request.</p>
|
|
2549
2826
|
* @public
|
|
@@ -2556,12 +2833,12 @@ export interface RoutePedestrianPlace {
|
|
|
2556
2833
|
*/
|
|
2557
2834
|
export interface RoutePedestrianArrival {
|
|
2558
2835
|
/**
|
|
2559
|
-
* <p>
|
|
2836
|
+
* <p>Place details corresponding to the arrival.</p>
|
|
2560
2837
|
* @public
|
|
2561
2838
|
*/
|
|
2562
2839
|
Place: RoutePedestrianPlace | undefined;
|
|
2563
2840
|
/**
|
|
2564
|
-
* <p>The time.</p>
|
|
2841
|
+
* <p>The arrival time.</p>
|
|
2565
2842
|
* @public
|
|
2566
2843
|
*/
|
|
2567
2844
|
Time?: string | undefined;
|
|
@@ -2572,12 +2849,12 @@ export interface RoutePedestrianArrival {
|
|
|
2572
2849
|
*/
|
|
2573
2850
|
export interface RoutePedestrianDeparture {
|
|
2574
2851
|
/**
|
|
2575
|
-
* <p>
|
|
2852
|
+
* <p>Place details corresponding to the departure.</p>
|
|
2576
2853
|
* @public
|
|
2577
2854
|
*/
|
|
2578
2855
|
Place: RoutePedestrianPlace | undefined;
|
|
2579
2856
|
/**
|
|
2580
|
-
* <p>The time.</p>
|
|
2857
|
+
* <p>The departure time.</p>
|
|
2581
2858
|
* @public
|
|
2582
2859
|
*/
|
|
2583
2860
|
Time?: string | undefined;
|
|
@@ -2738,17 +3015,17 @@ export interface RoutePedestrianSpan {
|
|
|
2738
3015
|
TypicalDuration?: number | undefined;
|
|
2739
3016
|
}
|
|
2740
3017
|
/**
|
|
2741
|
-
* <p>
|
|
3018
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
2742
3019
|
* @public
|
|
2743
3020
|
*/
|
|
2744
3021
|
export interface RoutePedestrianOverviewSummary {
|
|
2745
3022
|
/**
|
|
2746
|
-
* <p>Distance of the
|
|
3023
|
+
* <p>Distance of the entire leg.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
2747
3024
|
* @public
|
|
2748
3025
|
*/
|
|
2749
3026
|
Distance: number | undefined;
|
|
2750
3027
|
/**
|
|
2751
|
-
* <p>Duration of the
|
|
3028
|
+
* <p>Duration of the entire leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
2752
3029
|
* @public
|
|
2753
3030
|
*/
|
|
2754
3031
|
Duration: number | undefined;
|
|
@@ -3060,6 +3337,11 @@ export interface RoutePedestrianTravelStep {
|
|
|
3060
3337
|
* @public
|
|
3061
3338
|
*/
|
|
3062
3339
|
export interface RoutePedestrianLegDetails {
|
|
3340
|
+
/**
|
|
3341
|
+
* <p>Steps of a leg that must be performed after the travel portion of the leg.</p>
|
|
3342
|
+
* @public
|
|
3343
|
+
*/
|
|
3344
|
+
AfterTravelSteps: RoutePedestrianAfterTravelStep[] | undefined;
|
|
3063
3345
|
/**
|
|
3064
3346
|
* <p>Details corresponding to the arrival for the leg.</p>
|
|
3065
3347
|
* @public
|
|
@@ -3096,11 +3378,53 @@ export interface RoutePedestrianLegDetails {
|
|
|
3096
3378
|
*/
|
|
3097
3379
|
TravelSteps: RoutePedestrianTravelStep[] | undefined;
|
|
3098
3380
|
}
|
|
3381
|
+
/**
|
|
3382
|
+
* <p>A step that must be performed after the travel portion of the leg.</p>
|
|
3383
|
+
* @public
|
|
3384
|
+
*/
|
|
3385
|
+
export interface RouteRentalAfterTravelStep {
|
|
3386
|
+
/**
|
|
3387
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3388
|
+
* @public
|
|
3389
|
+
*/
|
|
3390
|
+
Duration: number | undefined;
|
|
3391
|
+
/**
|
|
3392
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
3393
|
+
* @public
|
|
3394
|
+
*/
|
|
3395
|
+
Instruction?: string | undefined;
|
|
3396
|
+
/**
|
|
3397
|
+
* <p>Type of the step.</p>
|
|
3398
|
+
* @public
|
|
3399
|
+
*/
|
|
3400
|
+
Type: RouteRentalAfterTravelStepType | undefined;
|
|
3401
|
+
}
|
|
3402
|
+
/**
|
|
3403
|
+
* <p>Details about the rental agency.</p>
|
|
3404
|
+
* @public
|
|
3405
|
+
*/
|
|
3406
|
+
export interface RouteRentalAgency {
|
|
3407
|
+
/**
|
|
3408
|
+
* <p>Name of the agency.</p>
|
|
3409
|
+
* @public
|
|
3410
|
+
*/
|
|
3411
|
+
Name: string | undefined;
|
|
3412
|
+
/**
|
|
3413
|
+
* <p>URL to the agency's website.</p>
|
|
3414
|
+
* @public
|
|
3415
|
+
*/
|
|
3416
|
+
Url?: string | undefined;
|
|
3417
|
+
}
|
|
3099
3418
|
/**
|
|
3100
3419
|
* <p>Place details corresponding to the arrival or departure.</p>
|
|
3101
3420
|
* @public
|
|
3102
3421
|
*/
|
|
3103
|
-
export interface
|
|
3422
|
+
export interface RouteRentalPlace {
|
|
3423
|
+
/**
|
|
3424
|
+
* <p>Details of the access point.</p>
|
|
3425
|
+
* @public
|
|
3426
|
+
*/
|
|
3427
|
+
AccessPointDetails?: RouteAccessPointDetails | undefined;
|
|
3104
3428
|
/**
|
|
3105
3429
|
* <p>The name of the place.</p>
|
|
3106
3430
|
* @public
|
|
@@ -3117,10 +3441,15 @@ export interface RouteVehiclePlace {
|
|
|
3117
3441
|
*/
|
|
3118
3442
|
Position: number[] | undefined;
|
|
3119
3443
|
/**
|
|
3120
|
-
* <p>
|
|
3444
|
+
* <p>Details about the station.</p>
|
|
3121
3445
|
* @public
|
|
3122
3446
|
*/
|
|
3123
|
-
|
|
3447
|
+
StationDetails?: RouteStationDetails | undefined;
|
|
3448
|
+
/**
|
|
3449
|
+
* <p>The type of the place.</p>
|
|
3450
|
+
* @public
|
|
3451
|
+
*/
|
|
3452
|
+
Type?: RouteRentalPlaceType | undefined;
|
|
3124
3453
|
/**
|
|
3125
3454
|
* <p>Index of the waypoint in the request.</p>
|
|
3126
3455
|
* @public
|
|
@@ -3128,54 +3457,1431 @@ export interface RouteVehiclePlace {
|
|
|
3128
3457
|
WaypointIndex?: number | undefined;
|
|
3129
3458
|
}
|
|
3130
3459
|
/**
|
|
3131
|
-
* <p>Details corresponding to the arrival for
|
|
3460
|
+
* <p>Details corresponding to the arrival for the leg.</p>
|
|
3132
3461
|
* @public
|
|
3133
3462
|
*/
|
|
3134
|
-
export interface
|
|
3463
|
+
export interface RouteRentalArrival {
|
|
3135
3464
|
/**
|
|
3136
|
-
* <p>
|
|
3465
|
+
* <p>Place details corresponding to the arrival.</p>
|
|
3137
3466
|
* @public
|
|
3138
3467
|
*/
|
|
3139
|
-
Place:
|
|
3468
|
+
Place: RouteRentalPlace | undefined;
|
|
3140
3469
|
/**
|
|
3141
|
-
* <p>The time.</p>
|
|
3470
|
+
* <p>The arrival time.</p>
|
|
3142
3471
|
* @public
|
|
3143
3472
|
*/
|
|
3144
3473
|
Time?: string | undefined;
|
|
3145
3474
|
}
|
|
3146
3475
|
/**
|
|
3147
|
-
* <p>
|
|
3476
|
+
* <p>The URL to an external resource.</p>
|
|
3148
3477
|
* @public
|
|
3149
3478
|
*/
|
|
3150
|
-
export interface
|
|
3479
|
+
export interface RouteWebLink {
|
|
3151
3480
|
/**
|
|
3152
|
-
* <p>The
|
|
3481
|
+
* <p>The interactive or clickable portion of the text.</p>
|
|
3153
3482
|
* @public
|
|
3154
3483
|
*/
|
|
3155
|
-
|
|
3484
|
+
AnchorText?: string | undefined;
|
|
3156
3485
|
/**
|
|
3157
|
-
* <p>
|
|
3486
|
+
* <p>Text describing the URL.</p>
|
|
3158
3487
|
* @public
|
|
3159
3488
|
*/
|
|
3160
|
-
|
|
3489
|
+
Description: string | undefined;
|
|
3490
|
+
/**
|
|
3491
|
+
* <p>Device type for which the link is intended.</p>
|
|
3492
|
+
* @public
|
|
3493
|
+
*/
|
|
3494
|
+
DeviceType?: RouteWebLinkDeviceType | undefined;
|
|
3495
|
+
/**
|
|
3496
|
+
* <p>The URL of the link.</p>
|
|
3497
|
+
* @public
|
|
3498
|
+
*/
|
|
3499
|
+
Url?: string | undefined;
|
|
3161
3500
|
}
|
|
3162
3501
|
/**
|
|
3163
|
-
* <p>
|
|
3502
|
+
* <p>Required attribution to display.</p>
|
|
3164
3503
|
* @public
|
|
3165
3504
|
*/
|
|
3166
|
-
export interface
|
|
3505
|
+
export interface RouteAttribution {
|
|
3167
3506
|
/**
|
|
3168
|
-
* <p>
|
|
3507
|
+
* <p>The type of the attribution link.</p>
|
|
3169
3508
|
* @public
|
|
3170
3509
|
*/
|
|
3171
|
-
|
|
3510
|
+
AttributionType?: RouteAttributionType | undefined;
|
|
3172
3511
|
/**
|
|
3173
|
-
* <p>
|
|
3512
|
+
* <p>The URL to an external resource.</p>
|
|
3174
3513
|
* @public
|
|
3175
3514
|
*/
|
|
3176
|
-
|
|
3515
|
+
WebLink: RouteWebLink | undefined;
|
|
3516
|
+
}
|
|
3517
|
+
/**
|
|
3518
|
+
* <p>A step that must be performed before the travel portion of the leg.</p>
|
|
3519
|
+
* @public
|
|
3520
|
+
*/
|
|
3521
|
+
export interface RouteRentalBeforeTravelStep {
|
|
3177
3522
|
/**
|
|
3178
|
-
* <p>
|
|
3523
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3524
|
+
* @public
|
|
3525
|
+
*/
|
|
3526
|
+
Duration: number | undefined;
|
|
3527
|
+
/**
|
|
3528
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
3529
|
+
* @public
|
|
3530
|
+
*/
|
|
3531
|
+
Instruction?: string | undefined;
|
|
3532
|
+
/**
|
|
3533
|
+
* <p>Type of the step.</p>
|
|
3534
|
+
* @public
|
|
3535
|
+
*/
|
|
3536
|
+
Type: RouteRentalBeforeTravelStepType | undefined;
|
|
3537
|
+
}
|
|
3538
|
+
/**
|
|
3539
|
+
* <p>Details corresponding to the departure for the leg.</p>
|
|
3540
|
+
* @public
|
|
3541
|
+
*/
|
|
3542
|
+
export interface RouteRentalDeparture {
|
|
3543
|
+
/**
|
|
3544
|
+
* <p>Place details corresponding to the departure.</p>
|
|
3545
|
+
* @public
|
|
3546
|
+
*/
|
|
3547
|
+
Place: RouteRentalPlace | undefined;
|
|
3548
|
+
/**
|
|
3549
|
+
* <p>The departure time.</p>
|
|
3550
|
+
* @public
|
|
3551
|
+
*/
|
|
3552
|
+
Time?: string | undefined;
|
|
3553
|
+
}
|
|
3554
|
+
/**
|
|
3555
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
3556
|
+
* @public
|
|
3557
|
+
*/
|
|
3558
|
+
export interface RouteRentalOverviewSummary {
|
|
3559
|
+
/**
|
|
3560
|
+
* <p>Duration of the entire leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3561
|
+
* @public
|
|
3562
|
+
*/
|
|
3563
|
+
Duration: number | undefined;
|
|
3564
|
+
/**
|
|
3565
|
+
* <p>Distance of the entire leg.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
3566
|
+
* @public
|
|
3567
|
+
*/
|
|
3568
|
+
Distance: number | undefined;
|
|
3569
|
+
}
|
|
3570
|
+
/**
|
|
3571
|
+
* <p>Summary including duration and distance for the travel portion of the leg only.</p>
|
|
3572
|
+
* @public
|
|
3573
|
+
*/
|
|
3574
|
+
export interface RouteRentalTravelOnlySummary {
|
|
3575
|
+
/**
|
|
3576
|
+
* <p>Duration of the travel portion of the rental leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3577
|
+
* @public
|
|
3578
|
+
*/
|
|
3579
|
+
Duration: number | undefined;
|
|
3580
|
+
}
|
|
3581
|
+
/**
|
|
3582
|
+
* <p>Summary of the rental leg.</p>
|
|
3583
|
+
* @public
|
|
3584
|
+
*/
|
|
3585
|
+
export interface RouteRentalSummary {
|
|
3586
|
+
/**
|
|
3587
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
3588
|
+
* @public
|
|
3589
|
+
*/
|
|
3590
|
+
Overview?: RouteRentalOverviewSummary | undefined;
|
|
3591
|
+
/**
|
|
3592
|
+
* <p>Summary including duration and distance for the travel portion of the leg only.</p>
|
|
3593
|
+
* @public
|
|
3594
|
+
*/
|
|
3595
|
+
TravelOnly?: RouteRentalTravelOnlySummary | undefined;
|
|
3596
|
+
}
|
|
3597
|
+
/**
|
|
3598
|
+
* <p>Transport mode details for the rental leg.</p>
|
|
3599
|
+
* @public
|
|
3600
|
+
*/
|
|
3601
|
+
export interface RouteRentalTransportModeDetails {
|
|
3602
|
+
/**
|
|
3603
|
+
* <p>Number of available seats in the vehicle.</p>
|
|
3604
|
+
* @public
|
|
3605
|
+
*/
|
|
3606
|
+
AvailableSeats?: number | undefined;
|
|
3607
|
+
/**
|
|
3608
|
+
* <p>Human readable transport category.</p>
|
|
3609
|
+
* @public
|
|
3610
|
+
*/
|
|
3611
|
+
Category?: string | undefined;
|
|
3612
|
+
/**
|
|
3613
|
+
* <p>Color of the transport polyline and background for the transport name.</p>
|
|
3614
|
+
* @public
|
|
3615
|
+
*/
|
|
3616
|
+
Color?: string | undefined;
|
|
3617
|
+
/**
|
|
3618
|
+
* <p>Vehicle engine type.</p>
|
|
3619
|
+
* @public
|
|
3620
|
+
*/
|
|
3621
|
+
Engine?: RouteEngineType | undefined;
|
|
3622
|
+
/**
|
|
3623
|
+
* <p>Vehicle license plate number.</p>
|
|
3624
|
+
* @public
|
|
3625
|
+
*/
|
|
3626
|
+
LicensePlate?: string | undefined;
|
|
3627
|
+
/**
|
|
3628
|
+
* <p>Mode of the rental transport.</p>
|
|
3629
|
+
* @public
|
|
3630
|
+
*/
|
|
3631
|
+
Mode: RouteRentalMode | undefined;
|
|
3632
|
+
/**
|
|
3633
|
+
* <p>Vehicle model.</p>
|
|
3634
|
+
* @public
|
|
3635
|
+
*/
|
|
3636
|
+
Model?: string | undefined;
|
|
3637
|
+
/**
|
|
3638
|
+
* <p>Vehicle name or mobility provider name.</p>
|
|
3639
|
+
* @public
|
|
3640
|
+
*/
|
|
3641
|
+
Name?: string | undefined;
|
|
3642
|
+
/**
|
|
3643
|
+
* <p>Color of the transport name text.</p>
|
|
3644
|
+
* @public
|
|
3645
|
+
*/
|
|
3646
|
+
TextColor?: string | undefined;
|
|
3647
|
+
}
|
|
3648
|
+
/**
|
|
3649
|
+
* <p>Details related to the exit step.</p>
|
|
3650
|
+
* @public
|
|
3651
|
+
*/
|
|
3652
|
+
export interface RouteExitStepDetails {
|
|
3653
|
+
/**
|
|
3654
|
+
* <p>Name of the intersection, if applicable to the step.</p>
|
|
3655
|
+
* @public
|
|
3656
|
+
*/
|
|
3657
|
+
Intersection: LocalizedString[] | undefined;
|
|
3658
|
+
/**
|
|
3659
|
+
* <p>Exit to be taken.</p>
|
|
3660
|
+
* @public
|
|
3661
|
+
*/
|
|
3662
|
+
RelativeExit?: number | undefined;
|
|
3663
|
+
/**
|
|
3664
|
+
* <p>Steering direction for the step.</p>
|
|
3665
|
+
* @public
|
|
3666
|
+
*/
|
|
3667
|
+
SteeringDirection?: RouteSteeringDirection | undefined;
|
|
3668
|
+
/**
|
|
3669
|
+
* <p>Angle of the turn.</p>
|
|
3670
|
+
* @public
|
|
3671
|
+
*/
|
|
3672
|
+
TurnAngle?: number | undefined;
|
|
3673
|
+
/**
|
|
3674
|
+
* <p>Intensity of the turn.</p>
|
|
3675
|
+
* @public
|
|
3676
|
+
*/
|
|
3677
|
+
TurnIntensity?: RouteTurnIntensity | undefined;
|
|
3678
|
+
}
|
|
3679
|
+
/**
|
|
3680
|
+
* <p>Details that are specific to a ramp step.</p>
|
|
3681
|
+
* @public
|
|
3682
|
+
*/
|
|
3683
|
+
export interface RouteRampStepDetails {
|
|
3684
|
+
/**
|
|
3685
|
+
* <p>Name of the intersection, if applicable to the step.</p>
|
|
3686
|
+
* @public
|
|
3687
|
+
*/
|
|
3688
|
+
Intersection: LocalizedString[] | undefined;
|
|
3689
|
+
/**
|
|
3690
|
+
* <p>Steering direction for the step.</p>
|
|
3691
|
+
* @public
|
|
3692
|
+
*/
|
|
3693
|
+
SteeringDirection?: RouteSteeringDirection | undefined;
|
|
3694
|
+
/**
|
|
3695
|
+
* <p>Angle of the turn.</p>
|
|
3696
|
+
* @public
|
|
3697
|
+
*/
|
|
3698
|
+
TurnAngle?: number | undefined;
|
|
3699
|
+
/**
|
|
3700
|
+
* <p>Intensity of the turn.</p>
|
|
3701
|
+
* @public
|
|
3702
|
+
*/
|
|
3703
|
+
TurnIntensity?: RouteTurnIntensity | undefined;
|
|
3704
|
+
}
|
|
3705
|
+
/**
|
|
3706
|
+
* <p>Details related to the U-turn step.</p>
|
|
3707
|
+
* @public
|
|
3708
|
+
*/
|
|
3709
|
+
export interface RouteUTurnStepDetails {
|
|
3710
|
+
/**
|
|
3711
|
+
* <p>Name of the intersection, if applicable to the step.</p>
|
|
3712
|
+
* @public
|
|
3713
|
+
*/
|
|
3714
|
+
Intersection: LocalizedString[] | undefined;
|
|
3715
|
+
/**
|
|
3716
|
+
* <p>Steering direction for the step.</p>
|
|
3717
|
+
* @public
|
|
3718
|
+
*/
|
|
3719
|
+
SteeringDirection?: RouteSteeringDirection | undefined;
|
|
3720
|
+
/**
|
|
3721
|
+
* <p>Angle of the turn.</p>
|
|
3722
|
+
* @public
|
|
3723
|
+
*/
|
|
3724
|
+
TurnAngle?: number | undefined;
|
|
3725
|
+
/**
|
|
3726
|
+
* <p>Intensity of the turn.</p>
|
|
3727
|
+
* @public
|
|
3728
|
+
*/
|
|
3729
|
+
TurnIntensity?: RouteTurnIntensity | undefined;
|
|
3730
|
+
}
|
|
3731
|
+
/**
|
|
3732
|
+
* <p>A step that must be performed during the travel portion of the leg.</p>
|
|
3733
|
+
* @public
|
|
3734
|
+
*/
|
|
3735
|
+
export interface RouteRentalTravelStep {
|
|
3736
|
+
/**
|
|
3737
|
+
* <p>Details related to the continue step.</p>
|
|
3738
|
+
* @public
|
|
3739
|
+
*/
|
|
3740
|
+
ContinueStepDetails?: RouteContinueStepDetails | undefined;
|
|
3741
|
+
/**
|
|
3742
|
+
* <p>Distance of the step.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
3743
|
+
* @public
|
|
3744
|
+
*/
|
|
3745
|
+
Distance?: number | undefined;
|
|
3746
|
+
/**
|
|
3747
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3748
|
+
* @public
|
|
3749
|
+
*/
|
|
3750
|
+
Duration: number | undefined;
|
|
3751
|
+
/**
|
|
3752
|
+
* <p>Details related to the exit step.</p>
|
|
3753
|
+
* @public
|
|
3754
|
+
*/
|
|
3755
|
+
ExitStepDetails?: RouteExitStepDetails | undefined;
|
|
3756
|
+
/**
|
|
3757
|
+
* <p>Offset in the leg geometry corresponding to the start of this step.</p>
|
|
3758
|
+
* @public
|
|
3759
|
+
*/
|
|
3760
|
+
GeometryOffset?: number | undefined;
|
|
3761
|
+
/**
|
|
3762
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
3763
|
+
* @public
|
|
3764
|
+
*/
|
|
3765
|
+
Instruction?: string | undefined;
|
|
3766
|
+
/**
|
|
3767
|
+
* <p>Details that are specific to a Keep step.</p>
|
|
3768
|
+
* @public
|
|
3769
|
+
*/
|
|
3770
|
+
KeepStepDetails?: RouteKeepStepDetails | undefined;
|
|
3771
|
+
/**
|
|
3772
|
+
* <p>Details that are specific to a ramp step.</p>
|
|
3773
|
+
* @public
|
|
3774
|
+
*/
|
|
3775
|
+
RampStepDetails?: RouteRampStepDetails | undefined;
|
|
3776
|
+
/**
|
|
3777
|
+
* <p>Details about the roundabout leg.</p>
|
|
3778
|
+
* @public
|
|
3779
|
+
*/
|
|
3780
|
+
RoundaboutEnterStepDetails?: RouteRoundaboutEnterStepDetails | undefined;
|
|
3781
|
+
/**
|
|
3782
|
+
* <p>Details about the roundabout step.</p>
|
|
3783
|
+
* @public
|
|
3784
|
+
*/
|
|
3785
|
+
RoundaboutExitStepDetails?: RouteRoundaboutExitStepDetails | undefined;
|
|
3786
|
+
/**
|
|
3787
|
+
* <p>Details about the step.</p>
|
|
3788
|
+
* @public
|
|
3789
|
+
*/
|
|
3790
|
+
RoundaboutPassStepDetails?: RouteRoundaboutPassStepDetails | undefined;
|
|
3791
|
+
/**
|
|
3792
|
+
* <p>Details related to the turn step.</p>
|
|
3793
|
+
* @public
|
|
3794
|
+
*/
|
|
3795
|
+
TurnStepDetails?: RouteTurnStepDetails | undefined;
|
|
3796
|
+
/**
|
|
3797
|
+
* <p>Type of the step.</p>
|
|
3798
|
+
* @public
|
|
3799
|
+
*/
|
|
3800
|
+
Type: RouteRentalTravelStepType | undefined;
|
|
3801
|
+
/**
|
|
3802
|
+
* <p>Details related to the U-turn step.</p>
|
|
3803
|
+
* @public
|
|
3804
|
+
*/
|
|
3805
|
+
UTurnStepDetails?: RouteUTurnStepDetails | undefined;
|
|
3806
|
+
}
|
|
3807
|
+
/**
|
|
3808
|
+
* <p>Populated when the Leg type is Rental, and provides additional information that is specific to rental vehicle travel.</p>
|
|
3809
|
+
* @public
|
|
3810
|
+
*/
|
|
3811
|
+
export interface RouteRentalLegDetails {
|
|
3812
|
+
/**
|
|
3813
|
+
* <p>Steps of a leg that must be performed after the travel portion of the leg.</p>
|
|
3814
|
+
* @public
|
|
3815
|
+
*/
|
|
3816
|
+
AfterTravelSteps: RouteRentalAfterTravelStep[] | undefined;
|
|
3817
|
+
/**
|
|
3818
|
+
* <p>Details about the rental agency.</p>
|
|
3819
|
+
* @public
|
|
3820
|
+
*/
|
|
3821
|
+
Agency: RouteRentalAgency | undefined;
|
|
3822
|
+
/**
|
|
3823
|
+
* <p>Details corresponding to the arrival for the leg.</p>
|
|
3824
|
+
* @public
|
|
3825
|
+
*/
|
|
3826
|
+
Arrival: RouteRentalArrival | undefined;
|
|
3827
|
+
/**
|
|
3828
|
+
* <p>List of required attributions to display.</p>
|
|
3829
|
+
* @public
|
|
3830
|
+
*/
|
|
3831
|
+
Attributions: RouteAttribution[] | undefined;
|
|
3832
|
+
/**
|
|
3833
|
+
* <p>Steps of a leg that must be performed before the travel portion of the leg.</p>
|
|
3834
|
+
* @public
|
|
3835
|
+
*/
|
|
3836
|
+
BeforeTravelSteps: RouteRentalBeforeTravelStep[] | undefined;
|
|
3837
|
+
/**
|
|
3838
|
+
* <p>Web links to external ticket booking services for the rental.</p>
|
|
3839
|
+
* @public
|
|
3840
|
+
*/
|
|
3841
|
+
BookingWebLinks: RouteWebLink[] | undefined;
|
|
3842
|
+
/**
|
|
3843
|
+
* <p>Details corresponding to the departure for the leg.</p>
|
|
3844
|
+
* @public
|
|
3845
|
+
*/
|
|
3846
|
+
Departure: RouteRentalDeparture | undefined;
|
|
3847
|
+
/**
|
|
3848
|
+
* <p>Summary of the rental leg.</p>
|
|
3849
|
+
* @public
|
|
3850
|
+
*/
|
|
3851
|
+
Summary?: RouteRentalSummary | undefined;
|
|
3852
|
+
/**
|
|
3853
|
+
* <p>Transport mode details for the rental leg.</p>
|
|
3854
|
+
* @public
|
|
3855
|
+
*/
|
|
3856
|
+
Transport: RouteRentalTransportModeDetails | undefined;
|
|
3857
|
+
/**
|
|
3858
|
+
* <p>Steps of a leg that must be performed during the travel portion of the leg.</p>
|
|
3859
|
+
* @public
|
|
3860
|
+
*/
|
|
3861
|
+
TravelSteps: RouteRentalTravelStep[] | undefined;
|
|
3862
|
+
}
|
|
3863
|
+
/**
|
|
3864
|
+
* <p>A step that must be performed after the travel portion of the leg.</p>
|
|
3865
|
+
* @public
|
|
3866
|
+
*/
|
|
3867
|
+
export interface RouteTaxiAfterTravelStep {
|
|
3868
|
+
/**
|
|
3869
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3870
|
+
* @public
|
|
3871
|
+
*/
|
|
3872
|
+
Duration: number | undefined;
|
|
3873
|
+
/**
|
|
3874
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
3875
|
+
* @public
|
|
3876
|
+
*/
|
|
3877
|
+
Instruction?: string | undefined;
|
|
3878
|
+
/**
|
|
3879
|
+
* <p>Type of the step.</p>
|
|
3880
|
+
* @public
|
|
3881
|
+
*/
|
|
3882
|
+
Type: RouteTaxiAfterTravelStepType | undefined;
|
|
3883
|
+
}
|
|
3884
|
+
/**
|
|
3885
|
+
* <p>Details about the taxi agency.</p>
|
|
3886
|
+
* @public
|
|
3887
|
+
*/
|
|
3888
|
+
export interface RouteTaxiAgency {
|
|
3889
|
+
/**
|
|
3890
|
+
* <p>Name of the agency.</p>
|
|
3891
|
+
* @public
|
|
3892
|
+
*/
|
|
3893
|
+
Name: string | undefined;
|
|
3894
|
+
/**
|
|
3895
|
+
* <p>URL to the agency's website.</p>
|
|
3896
|
+
* @public
|
|
3897
|
+
*/
|
|
3898
|
+
Url?: string | undefined;
|
|
3899
|
+
}
|
|
3900
|
+
/**
|
|
3901
|
+
* <p>Place details corresponding to the arrival or departure.</p>
|
|
3902
|
+
* @public
|
|
3903
|
+
*/
|
|
3904
|
+
export interface RouteTaxiPlace {
|
|
3905
|
+
/**
|
|
3906
|
+
* <p>Details of the access point.</p>
|
|
3907
|
+
* @public
|
|
3908
|
+
*/
|
|
3909
|
+
AccessPointDetails?: RouteAccessPointDetails | undefined;
|
|
3910
|
+
/**
|
|
3911
|
+
* <p>The name of the place.</p>
|
|
3912
|
+
* @public
|
|
3913
|
+
*/
|
|
3914
|
+
Name?: string | undefined;
|
|
3915
|
+
/**
|
|
3916
|
+
* <p>Position provided in the request.</p>
|
|
3917
|
+
* @public
|
|
3918
|
+
*/
|
|
3919
|
+
OriginalPosition?: number[] | undefined;
|
|
3920
|
+
/**
|
|
3921
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
3922
|
+
* @public
|
|
3923
|
+
*/
|
|
3924
|
+
Position: number[] | undefined;
|
|
3925
|
+
/**
|
|
3926
|
+
* <p>Details about the station.</p>
|
|
3927
|
+
* @public
|
|
3928
|
+
*/
|
|
3929
|
+
StationDetails?: RouteStationDetails | undefined;
|
|
3930
|
+
/**
|
|
3931
|
+
* <p>The type of the place.</p>
|
|
3932
|
+
* @public
|
|
3933
|
+
*/
|
|
3934
|
+
Type?: RouteTaxiPlaceType | undefined;
|
|
3935
|
+
/**
|
|
3936
|
+
* <p>Index of the waypoint in the request.</p>
|
|
3937
|
+
* @public
|
|
3938
|
+
*/
|
|
3939
|
+
WaypointIndex?: number | undefined;
|
|
3940
|
+
}
|
|
3941
|
+
/**
|
|
3942
|
+
* <p>Details corresponding to the arrival for the leg.</p>
|
|
3943
|
+
* @public
|
|
3944
|
+
*/
|
|
3945
|
+
export interface RouteTaxiArrival {
|
|
3946
|
+
/**
|
|
3947
|
+
* <p>Place details corresponding to the arrival.</p>
|
|
3948
|
+
* @public
|
|
3949
|
+
*/
|
|
3950
|
+
Place: RouteTaxiPlace | undefined;
|
|
3951
|
+
/**
|
|
3952
|
+
* <p>The arrival time.</p>
|
|
3953
|
+
* @public
|
|
3954
|
+
*/
|
|
3955
|
+
Time?: string | undefined;
|
|
3956
|
+
}
|
|
3957
|
+
/**
|
|
3958
|
+
* <p>A step that must be performed before the travel portion of the leg.</p>
|
|
3959
|
+
* @public
|
|
3960
|
+
*/
|
|
3961
|
+
export interface RouteTaxiBeforeTravelStep {
|
|
3962
|
+
/**
|
|
3963
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3964
|
+
* @public
|
|
3965
|
+
*/
|
|
3966
|
+
Duration: number | undefined;
|
|
3967
|
+
/**
|
|
3968
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
3969
|
+
* @public
|
|
3970
|
+
*/
|
|
3971
|
+
Instruction?: string | undefined;
|
|
3972
|
+
/**
|
|
3973
|
+
* <p>Type of the step.</p>
|
|
3974
|
+
* @public
|
|
3975
|
+
*/
|
|
3976
|
+
Type: RouteTaxiBeforeTravelStepType | undefined;
|
|
3977
|
+
}
|
|
3978
|
+
/**
|
|
3979
|
+
* <p>Details corresponding to the departure for the leg.</p>
|
|
3980
|
+
* @public
|
|
3981
|
+
*/
|
|
3982
|
+
export interface RouteTaxiDeparture {
|
|
3983
|
+
/**
|
|
3984
|
+
* <p>Place details corresponding to the departure.</p>
|
|
3985
|
+
* @public
|
|
3986
|
+
*/
|
|
3987
|
+
Place: RouteTaxiPlace | undefined;
|
|
3988
|
+
/**
|
|
3989
|
+
* <p>The departure time.</p>
|
|
3990
|
+
* @public
|
|
3991
|
+
*/
|
|
3992
|
+
Time?: string | undefined;
|
|
3993
|
+
}
|
|
3994
|
+
/**
|
|
3995
|
+
* <p>A notice that indicates an issue that occurred during route calculation.</p>
|
|
3996
|
+
* @public
|
|
3997
|
+
*/
|
|
3998
|
+
export interface RouteTaxiNotice {
|
|
3999
|
+
/**
|
|
4000
|
+
* <p>Code corresponding to the issue.</p>
|
|
4001
|
+
* @public
|
|
4002
|
+
*/
|
|
4003
|
+
Code: RouteTaxiNoticeCode | undefined;
|
|
4004
|
+
/**
|
|
4005
|
+
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.</p>
|
|
4006
|
+
* @public
|
|
4007
|
+
*/
|
|
4008
|
+
Impact?: RouteNoticeImpact | undefined;
|
|
4009
|
+
}
|
|
4010
|
+
/**
|
|
4011
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
4012
|
+
* @public
|
|
4013
|
+
*/
|
|
4014
|
+
export interface RouteTaxiOverviewSummary {
|
|
4015
|
+
/**
|
|
4016
|
+
* <p>Duration of the entire leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4017
|
+
* @public
|
|
4018
|
+
*/
|
|
4019
|
+
Duration: number | undefined;
|
|
4020
|
+
/**
|
|
4021
|
+
* <p>Distance of the entire leg.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
4022
|
+
* @public
|
|
4023
|
+
*/
|
|
4024
|
+
Distance: number | undefined;
|
|
4025
|
+
}
|
|
4026
|
+
/**
|
|
4027
|
+
* <p>Summary including duration and distance for the travel portion of the leg only.</p>
|
|
4028
|
+
* @public
|
|
4029
|
+
*/
|
|
4030
|
+
export interface RouteTaxiTravelOnlySummary {
|
|
4031
|
+
/**
|
|
4032
|
+
* <p>Duration of the travel portion of the taxi leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4033
|
+
* @public
|
|
4034
|
+
*/
|
|
4035
|
+
Duration: number | undefined;
|
|
4036
|
+
}
|
|
4037
|
+
/**
|
|
4038
|
+
* <p>Summary of the taxi leg.</p>
|
|
4039
|
+
* @public
|
|
4040
|
+
*/
|
|
4041
|
+
export interface RouteTaxiSummary {
|
|
4042
|
+
/**
|
|
4043
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
4044
|
+
* @public
|
|
4045
|
+
*/
|
|
4046
|
+
Overview?: RouteTaxiOverviewSummary | undefined;
|
|
4047
|
+
/**
|
|
4048
|
+
* <p>Summary including duration and distance for the travel portion of the leg only.</p>
|
|
4049
|
+
* @public
|
|
4050
|
+
*/
|
|
4051
|
+
TravelOnly?: RouteTaxiTravelOnlySummary | undefined;
|
|
4052
|
+
}
|
|
4053
|
+
/**
|
|
4054
|
+
* <p>Transport mode details for the taxi leg.</p>
|
|
4055
|
+
* @public
|
|
4056
|
+
*/
|
|
4057
|
+
export interface RouteTaxiTransportModeDetails {
|
|
4058
|
+
/**
|
|
4059
|
+
* <p>Number of available seats in the vehicle.</p>
|
|
4060
|
+
* @public
|
|
4061
|
+
*/
|
|
4062
|
+
AvailableSeats?: number | undefined;
|
|
4063
|
+
/**
|
|
4064
|
+
* <p>Human readable transport category.</p>
|
|
4065
|
+
* @public
|
|
4066
|
+
*/
|
|
4067
|
+
Category?: string | undefined;
|
|
4068
|
+
/**
|
|
4069
|
+
* <p>Color of the transport polyline and background for the transport name.</p>
|
|
4070
|
+
* @public
|
|
4071
|
+
*/
|
|
4072
|
+
Color?: string | undefined;
|
|
4073
|
+
/**
|
|
4074
|
+
* <p>Vehicle engine type.</p>
|
|
4075
|
+
* @public
|
|
4076
|
+
*/
|
|
4077
|
+
Engine?: RouteEngineType | undefined;
|
|
4078
|
+
/**
|
|
4079
|
+
* <p>Vehicle license plate number.</p>
|
|
4080
|
+
* @public
|
|
4081
|
+
*/
|
|
4082
|
+
LicensePlate?: string | undefined;
|
|
4083
|
+
/**
|
|
4084
|
+
* <p>Mode of the taxi transport.</p>
|
|
4085
|
+
* @public
|
|
4086
|
+
*/
|
|
4087
|
+
Mode: RouteTaxiMode | undefined;
|
|
4088
|
+
/**
|
|
4089
|
+
* <p>Vehicle model.</p>
|
|
4090
|
+
* @public
|
|
4091
|
+
*/
|
|
4092
|
+
Model?: string | undefined;
|
|
4093
|
+
/**
|
|
4094
|
+
* <p>Vehicle name or mobility provider name.</p>
|
|
4095
|
+
* @public
|
|
4096
|
+
*/
|
|
4097
|
+
Name?: string | undefined;
|
|
4098
|
+
/**
|
|
4099
|
+
* <p>Color of the transport name text.</p>
|
|
4100
|
+
* @public
|
|
4101
|
+
*/
|
|
4102
|
+
TextColor?: string | undefined;
|
|
4103
|
+
}
|
|
4104
|
+
/**
|
|
4105
|
+
* <p>A step that must be performed during the travel portion of the leg.</p>
|
|
4106
|
+
* @public
|
|
4107
|
+
*/
|
|
4108
|
+
export interface RouteTaxiTravelStep {
|
|
4109
|
+
/**
|
|
4110
|
+
* <p>Details related to the continue step.</p>
|
|
4111
|
+
* @public
|
|
4112
|
+
*/
|
|
4113
|
+
ContinueStepDetails?: RouteContinueStepDetails | undefined;
|
|
4114
|
+
/**
|
|
4115
|
+
* <p>Distance of the step.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
4116
|
+
* @public
|
|
4117
|
+
*/
|
|
4118
|
+
Distance?: number | undefined;
|
|
4119
|
+
/**
|
|
4120
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4121
|
+
* @public
|
|
4122
|
+
*/
|
|
4123
|
+
Duration: number | undefined;
|
|
4124
|
+
/**
|
|
4125
|
+
* <p>Details related to the exit step.</p>
|
|
4126
|
+
* @public
|
|
4127
|
+
*/
|
|
4128
|
+
ExitStepDetails?: RouteExitStepDetails | undefined;
|
|
4129
|
+
/**
|
|
4130
|
+
* <p>Offset in the leg geometry corresponding to the start of this step.</p>
|
|
4131
|
+
* @public
|
|
4132
|
+
*/
|
|
4133
|
+
GeometryOffset?: number | undefined;
|
|
4134
|
+
/**
|
|
4135
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
4136
|
+
* @public
|
|
4137
|
+
*/
|
|
4138
|
+
Instruction?: string | undefined;
|
|
4139
|
+
/**
|
|
4140
|
+
* <p>Details that are specific to a Keep step.</p>
|
|
4141
|
+
* @public
|
|
4142
|
+
*/
|
|
4143
|
+
KeepStepDetails?: RouteKeepStepDetails | undefined;
|
|
4144
|
+
/**
|
|
4145
|
+
* <p>Details that are specific to a ramp step.</p>
|
|
4146
|
+
* @public
|
|
4147
|
+
*/
|
|
4148
|
+
RampStepDetails?: RouteRampStepDetails | undefined;
|
|
4149
|
+
/**
|
|
4150
|
+
* <p>Details about the roundabout leg.</p>
|
|
4151
|
+
* @public
|
|
4152
|
+
*/
|
|
4153
|
+
RoundaboutEnterStepDetails?: RouteRoundaboutEnterStepDetails | undefined;
|
|
4154
|
+
/**
|
|
4155
|
+
* <p>Details about the roundabout step.</p>
|
|
4156
|
+
* @public
|
|
4157
|
+
*/
|
|
4158
|
+
RoundaboutExitStepDetails?: RouteRoundaboutExitStepDetails | undefined;
|
|
4159
|
+
/**
|
|
4160
|
+
* <p>Details about the step.</p>
|
|
4161
|
+
* @public
|
|
4162
|
+
*/
|
|
4163
|
+
RoundaboutPassStepDetails?: RouteRoundaboutPassStepDetails | undefined;
|
|
4164
|
+
/**
|
|
4165
|
+
* <p>Details related to the turn step.</p>
|
|
4166
|
+
* @public
|
|
4167
|
+
*/
|
|
4168
|
+
TurnStepDetails?: RouteTurnStepDetails | undefined;
|
|
4169
|
+
/**
|
|
4170
|
+
* <p>Type of the step.</p>
|
|
4171
|
+
* @public
|
|
4172
|
+
*/
|
|
4173
|
+
Type: RouteTaxiTravelStepType | undefined;
|
|
4174
|
+
/**
|
|
4175
|
+
* <p>Details related to the U-turn step.</p>
|
|
4176
|
+
* @public
|
|
4177
|
+
*/
|
|
4178
|
+
UTurnStepDetails?: RouteUTurnStepDetails | undefined;
|
|
4179
|
+
}
|
|
4180
|
+
/**
|
|
4181
|
+
* <p>Populated when the Leg type is Taxi, and provides additional information that is specific to taxi travel.</p>
|
|
4182
|
+
* @public
|
|
4183
|
+
*/
|
|
4184
|
+
export interface RouteTaxiLegDetails {
|
|
4185
|
+
/**
|
|
4186
|
+
* <p>Steps of a leg that must be performed after the travel portion of the leg.</p>
|
|
4187
|
+
* @public
|
|
4188
|
+
*/
|
|
4189
|
+
AfterTravelSteps: RouteTaxiAfterTravelStep[] | undefined;
|
|
4190
|
+
/**
|
|
4191
|
+
* <p>Details about the taxi agency.</p>
|
|
4192
|
+
* @public
|
|
4193
|
+
*/
|
|
4194
|
+
Agency: RouteTaxiAgency | undefined;
|
|
4195
|
+
/**
|
|
4196
|
+
* <p>Details corresponding to the arrival for the leg.</p>
|
|
4197
|
+
* @public
|
|
4198
|
+
*/
|
|
4199
|
+
Arrival: RouteTaxiArrival | undefined;
|
|
4200
|
+
/**
|
|
4201
|
+
* <p>List of required attributions to display.</p>
|
|
4202
|
+
* @public
|
|
4203
|
+
*/
|
|
4204
|
+
Attributions: RouteAttribution[] | undefined;
|
|
4205
|
+
/**
|
|
4206
|
+
* <p>Steps of a leg that must be performed before the travel portion of the leg.</p>
|
|
4207
|
+
* @public
|
|
4208
|
+
*/
|
|
4209
|
+
BeforeTravelSteps: RouteTaxiBeforeTravelStep[] | undefined;
|
|
4210
|
+
/**
|
|
4211
|
+
* <p>Web links to external ticket booking services for the taxi.</p>
|
|
4212
|
+
* @public
|
|
4213
|
+
*/
|
|
4214
|
+
BookingWebLinks: RouteWebLink[] | undefined;
|
|
4215
|
+
/**
|
|
4216
|
+
* <p>Details corresponding to the departure for the leg.</p>
|
|
4217
|
+
* @public
|
|
4218
|
+
*/
|
|
4219
|
+
Departure: RouteTaxiDeparture | undefined;
|
|
4220
|
+
/**
|
|
4221
|
+
* <p>List of notices that indicate issues that occurred during route calculation.</p>
|
|
4222
|
+
* @public
|
|
4223
|
+
*/
|
|
4224
|
+
Notices: RouteTaxiNotice[] | undefined;
|
|
4225
|
+
/**
|
|
4226
|
+
* <p>Summary of the taxi leg.</p>
|
|
4227
|
+
* @public
|
|
4228
|
+
*/
|
|
4229
|
+
Summary?: RouteTaxiSummary | undefined;
|
|
4230
|
+
/**
|
|
4231
|
+
* <p>Transport mode details for the taxi leg.</p>
|
|
4232
|
+
* @public
|
|
4233
|
+
*/
|
|
4234
|
+
Transport: RouteTaxiTransportModeDetails | undefined;
|
|
4235
|
+
/**
|
|
4236
|
+
* <p>Steps of a leg that must be performed during the travel portion of the leg.</p>
|
|
4237
|
+
* @public
|
|
4238
|
+
*/
|
|
4239
|
+
TravelSteps: RouteTaxiTravelStep[] | undefined;
|
|
4240
|
+
}
|
|
4241
|
+
/**
|
|
4242
|
+
* <p>A step that must be performed after the travel portion of the leg.</p>
|
|
4243
|
+
* @public
|
|
4244
|
+
*/
|
|
4245
|
+
export interface RouteTransitAfterTravelStep {
|
|
4246
|
+
/**
|
|
4247
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4248
|
+
* @public
|
|
4249
|
+
*/
|
|
4250
|
+
Duration: number | undefined;
|
|
4251
|
+
/**
|
|
4252
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
4253
|
+
* @public
|
|
4254
|
+
*/
|
|
4255
|
+
Instruction?: string | undefined;
|
|
4256
|
+
/**
|
|
4257
|
+
* <p>Type of the step.</p>
|
|
4258
|
+
* @public
|
|
4259
|
+
*/
|
|
4260
|
+
Type: RouteTransitAfterTravelStepType | undefined;
|
|
4261
|
+
}
|
|
4262
|
+
/**
|
|
4263
|
+
* <p>Details about the transit agency.</p>
|
|
4264
|
+
* @public
|
|
4265
|
+
*/
|
|
4266
|
+
export interface RouteTransitAgency {
|
|
4267
|
+
/**
|
|
4268
|
+
* <p>Name of the agency.</p>
|
|
4269
|
+
* @public
|
|
4270
|
+
*/
|
|
4271
|
+
Name: string | undefined;
|
|
4272
|
+
/**
|
|
4273
|
+
* <p>URL to the agency's website.</p>
|
|
4274
|
+
* @public
|
|
4275
|
+
*/
|
|
4276
|
+
Url?: string | undefined;
|
|
4277
|
+
}
|
|
4278
|
+
/**
|
|
4279
|
+
* <p>Place details corresponding to the arrival or departure.</p>
|
|
4280
|
+
* @public
|
|
4281
|
+
*/
|
|
4282
|
+
export interface RouteTransitPlace {
|
|
4283
|
+
/**
|
|
4284
|
+
* <p>The name of the place.</p>
|
|
4285
|
+
* @public
|
|
4286
|
+
*/
|
|
4287
|
+
Name?: string | undefined;
|
|
4288
|
+
/**
|
|
4289
|
+
* <p>Position provided in the request.</p>
|
|
4290
|
+
* @public
|
|
4291
|
+
*/
|
|
4292
|
+
OriginalPosition?: number[] | undefined;
|
|
4293
|
+
/**
|
|
4294
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
4295
|
+
* @public
|
|
4296
|
+
*/
|
|
4297
|
+
Position: number[] | undefined;
|
|
4298
|
+
/**
|
|
4299
|
+
* <p>Details about the station.</p>
|
|
4300
|
+
* @public
|
|
4301
|
+
*/
|
|
4302
|
+
StationDetails?: RouteStationDetails | undefined;
|
|
4303
|
+
/**
|
|
4304
|
+
* <p>The type of the place.</p>
|
|
4305
|
+
* @public
|
|
4306
|
+
*/
|
|
4307
|
+
Type?: RouteTransitPlaceType | undefined;
|
|
4308
|
+
/**
|
|
4309
|
+
* <p>Index of the waypoint in the request.</p>
|
|
4310
|
+
* @public
|
|
4311
|
+
*/
|
|
4312
|
+
WaypointIndex?: number | undefined;
|
|
4313
|
+
}
|
|
4314
|
+
/**
|
|
4315
|
+
* <p>Details corresponding to the arrival for the leg.</p>
|
|
4316
|
+
* @public
|
|
4317
|
+
*/
|
|
4318
|
+
export interface RouteTransitArrival {
|
|
4319
|
+
/**
|
|
4320
|
+
* <p>The delay from the scheduled arrival time.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4321
|
+
* @public
|
|
4322
|
+
*/
|
|
4323
|
+
Delay?: number | undefined;
|
|
4324
|
+
/**
|
|
4325
|
+
* <p>Place details corresponding to the arrival.</p>
|
|
4326
|
+
* @public
|
|
4327
|
+
*/
|
|
4328
|
+
Place: RouteTransitPlace | undefined;
|
|
4329
|
+
/**
|
|
4330
|
+
* <p>The status of the arrival.</p>
|
|
4331
|
+
* @public
|
|
4332
|
+
*/
|
|
4333
|
+
Status?: RouteTransitTripStatus | undefined;
|
|
4334
|
+
/**
|
|
4335
|
+
* <p>The arrival time.</p>
|
|
4336
|
+
* @public
|
|
4337
|
+
*/
|
|
4338
|
+
Time?: string | undefined;
|
|
4339
|
+
}
|
|
4340
|
+
/**
|
|
4341
|
+
* <p>A step that must be performed before the travel portion of the leg.</p>
|
|
4342
|
+
* @public
|
|
4343
|
+
*/
|
|
4344
|
+
export interface RouteTransitBeforeTravelStep {
|
|
4345
|
+
/**
|
|
4346
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4347
|
+
* @public
|
|
4348
|
+
*/
|
|
4349
|
+
Duration: number | undefined;
|
|
4350
|
+
/**
|
|
4351
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
4352
|
+
* @public
|
|
4353
|
+
*/
|
|
4354
|
+
Instruction?: string | undefined;
|
|
4355
|
+
/**
|
|
4356
|
+
* <p>Type of the step.</p>
|
|
4357
|
+
* @public
|
|
4358
|
+
*/
|
|
4359
|
+
Type: RouteTransitBeforeTravelStepType | undefined;
|
|
4360
|
+
}
|
|
4361
|
+
/**
|
|
4362
|
+
* <p>Details corresponding to the departure for the leg.</p>
|
|
4363
|
+
* @public
|
|
4364
|
+
*/
|
|
4365
|
+
export interface RouteTransitDeparture {
|
|
4366
|
+
/**
|
|
4367
|
+
* <p>The delay from the scheduled departure time.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4368
|
+
* @public
|
|
4369
|
+
*/
|
|
4370
|
+
Delay?: number | undefined;
|
|
4371
|
+
/**
|
|
4372
|
+
* <p>Place details corresponding to the departure.</p>
|
|
4373
|
+
* @public
|
|
4374
|
+
*/
|
|
4375
|
+
Place: RouteTransitPlace | undefined;
|
|
4376
|
+
/**
|
|
4377
|
+
* <p>The status of the departure.</p>
|
|
4378
|
+
* @public
|
|
4379
|
+
*/
|
|
4380
|
+
Status?: RouteTransitTripStatus | undefined;
|
|
4381
|
+
/**
|
|
4382
|
+
* <p>The departure time.</p>
|
|
4383
|
+
* @public
|
|
4384
|
+
*/
|
|
4385
|
+
Time?: string | undefined;
|
|
4386
|
+
}
|
|
4387
|
+
/**
|
|
4388
|
+
* <p>An incident describes disruptions on the transit route.</p>
|
|
4389
|
+
* @public
|
|
4390
|
+
*/
|
|
4391
|
+
export interface RouteTransitIncident {
|
|
4392
|
+
/**
|
|
4393
|
+
* <p>A human readable description of the incident.</p>
|
|
4394
|
+
* @public
|
|
4395
|
+
*/
|
|
4396
|
+
Description?: string | undefined;
|
|
4397
|
+
/**
|
|
4398
|
+
* <p>The effect of the incident on the transit service.</p>
|
|
4399
|
+
* @public
|
|
4400
|
+
*/
|
|
4401
|
+
Effect: RouteTransitIncidentEffect | undefined;
|
|
4402
|
+
/**
|
|
4403
|
+
* <p>The end time of the incident.</p>
|
|
4404
|
+
* @public
|
|
4405
|
+
*/
|
|
4406
|
+
EndTime?: string | undefined;
|
|
4407
|
+
/**
|
|
4408
|
+
* <p>The start time of the incident.</p>
|
|
4409
|
+
* @public
|
|
4410
|
+
*/
|
|
4411
|
+
StartTime?: string | undefined;
|
|
4412
|
+
/**
|
|
4413
|
+
* <p>Type of the incident.</p>
|
|
4414
|
+
* @public
|
|
4415
|
+
*/
|
|
4416
|
+
Type: RouteTransitIncidentType | undefined;
|
|
4417
|
+
/**
|
|
4418
|
+
* <p>URL to the original incident published at the agency website.</p>
|
|
4419
|
+
* @public
|
|
4420
|
+
*/
|
|
4421
|
+
Url?: string | undefined;
|
|
4422
|
+
}
|
|
4423
|
+
/**
|
|
4424
|
+
* <p>Transport mode details for the transit leg.</p>
|
|
4425
|
+
* @public
|
|
4426
|
+
*/
|
|
4427
|
+
export interface RouteTransitTransportModeDetails {
|
|
4428
|
+
/**
|
|
4429
|
+
* <p>Wheelchair accessibility information for the transit vehicle.</p>
|
|
4430
|
+
* @public
|
|
4431
|
+
*/
|
|
4432
|
+
Accessibility?: RouteAccessibilityAvailabilityDetails | undefined;
|
|
4433
|
+
/**
|
|
4434
|
+
* <p>Color of the transport polyline and background for the transport name.</p>
|
|
4435
|
+
* @public
|
|
4436
|
+
*/
|
|
4437
|
+
Color?: string | undefined;
|
|
4438
|
+
/**
|
|
4439
|
+
* <p>Transit route headsign.</p>
|
|
4440
|
+
* @public
|
|
4441
|
+
*/
|
|
4442
|
+
Headsign?: string | undefined;
|
|
4443
|
+
/**
|
|
4444
|
+
* <p>Long name of the transit route.</p>
|
|
4445
|
+
* @public
|
|
4446
|
+
*/
|
|
4447
|
+
LongRouteName?: string | undefined;
|
|
4448
|
+
/**
|
|
4449
|
+
* <p>Mode of the transit transport.</p>
|
|
4450
|
+
* @public
|
|
4451
|
+
*/
|
|
4452
|
+
Mode: RouteTransitMode | undefined;
|
|
4453
|
+
/**
|
|
4454
|
+
* <p>Transit route name.</p>
|
|
4455
|
+
* @public
|
|
4456
|
+
*/
|
|
4457
|
+
RouteName?: string | undefined;
|
|
4458
|
+
/**
|
|
4459
|
+
* <p>Short name of the transit route.</p>
|
|
4460
|
+
* @public
|
|
4461
|
+
*/
|
|
4462
|
+
ShortRouteName?: string | undefined;
|
|
4463
|
+
/**
|
|
4464
|
+
* <p>Color of the transport name text.</p>
|
|
4465
|
+
* @public
|
|
4466
|
+
*/
|
|
4467
|
+
TextColor?: string | undefined;
|
|
4468
|
+
}
|
|
4469
|
+
/**
|
|
4470
|
+
* <p>An intermediate stop between departure and destination of the transit route.</p>
|
|
4471
|
+
* @public
|
|
4472
|
+
*/
|
|
4473
|
+
export interface RouteTransitIntermediateStop {
|
|
4474
|
+
/**
|
|
4475
|
+
* <p>Attributes of the intermediate stop.</p>
|
|
4476
|
+
* @public
|
|
4477
|
+
*/
|
|
4478
|
+
Attributes?: RouteTransitIntermediateStopAttribute[] | undefined;
|
|
4479
|
+
/**
|
|
4480
|
+
* <p>Departure details for the intermediate stop.</p>
|
|
4481
|
+
* @public
|
|
4482
|
+
*/
|
|
4483
|
+
Departure: RouteTransitDeparture | undefined;
|
|
4484
|
+
/**
|
|
4485
|
+
* <p>Duration of the stop.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4486
|
+
* @public
|
|
4487
|
+
*/
|
|
4488
|
+
Duration: number | undefined;
|
|
4489
|
+
/**
|
|
4490
|
+
* <p>Offset in the leg geometry corresponding to the start of this stop.</p>
|
|
4491
|
+
* @public
|
|
4492
|
+
*/
|
|
4493
|
+
GeometryOffset?: number | undefined;
|
|
4494
|
+
/**
|
|
4495
|
+
* <p>Transport mode details at the intermediate stop.</p>
|
|
4496
|
+
* @public
|
|
4497
|
+
*/
|
|
4498
|
+
Transport?: RouteTransitTransportModeDetails | undefined;
|
|
4499
|
+
}
|
|
4500
|
+
/**
|
|
4501
|
+
* <p>Details about the next available departure for the transit service.</p>
|
|
4502
|
+
* @public
|
|
4503
|
+
*/
|
|
4504
|
+
export interface RouteTransitNextDeparture {
|
|
4505
|
+
/**
|
|
4506
|
+
* <p>The delay from the scheduled departure time.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4507
|
+
* @public
|
|
4508
|
+
*/
|
|
4509
|
+
Delay?: number | undefined;
|
|
4510
|
+
/**
|
|
4511
|
+
* <p>Platform name or number for the departure.</p>
|
|
4512
|
+
* @public
|
|
4513
|
+
*/
|
|
4514
|
+
PlatformName?: string | undefined;
|
|
4515
|
+
/**
|
|
4516
|
+
* <p>The status of the departure.</p>
|
|
4517
|
+
* @public
|
|
4518
|
+
*/
|
|
4519
|
+
Status?: RouteTransitTripStatus | undefined;
|
|
4520
|
+
/**
|
|
4521
|
+
* <p>The departure time.</p>
|
|
4522
|
+
* @public
|
|
4523
|
+
*/
|
|
4524
|
+
Time: string | undefined;
|
|
4525
|
+
/**
|
|
4526
|
+
* <p>Transport mode details for this departure.</p>
|
|
4527
|
+
* @public
|
|
4528
|
+
*/
|
|
4529
|
+
Transport?: RouteTransitTransportModeDetails | undefined;
|
|
4530
|
+
}
|
|
4531
|
+
/**
|
|
4532
|
+
* <p>A notice that indicates an issue that occurred during route calculation.</p>
|
|
4533
|
+
* @public
|
|
4534
|
+
*/
|
|
4535
|
+
export interface RouteTransitNotice {
|
|
4536
|
+
/**
|
|
4537
|
+
* <p>Code corresponding to the issue.</p>
|
|
4538
|
+
* @public
|
|
4539
|
+
*/
|
|
4540
|
+
Code: RouteTransitNoticeCode | undefined;
|
|
4541
|
+
/**
|
|
4542
|
+
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.</p>
|
|
4543
|
+
* @public
|
|
4544
|
+
*/
|
|
4545
|
+
Impact?: RouteNoticeImpact | undefined;
|
|
4546
|
+
}
|
|
4547
|
+
/**
|
|
4548
|
+
* <p>Span computed for the requested SpanAdditionalFeatures.</p>
|
|
4549
|
+
* @public
|
|
4550
|
+
*/
|
|
4551
|
+
export interface RouteTransitSpan {
|
|
4552
|
+
/**
|
|
4553
|
+
* <p>3 letter Country code corresponding to the Span.</p>
|
|
4554
|
+
* @public
|
|
4555
|
+
*/
|
|
4556
|
+
Country?: string | undefined;
|
|
4557
|
+
/**
|
|
4558
|
+
* <p>Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
4559
|
+
* @public
|
|
4560
|
+
*/
|
|
4561
|
+
Distance?: number | undefined;
|
|
4562
|
+
/**
|
|
4563
|
+
* <p>Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4564
|
+
* @public
|
|
4565
|
+
*/
|
|
4566
|
+
Duration?: number | undefined;
|
|
4567
|
+
/**
|
|
4568
|
+
* <p>Offset in the leg geometry corresponding to the start of this span.</p>
|
|
4569
|
+
* @public
|
|
4570
|
+
*/
|
|
4571
|
+
GeometryOffset?: number | undefined;
|
|
4572
|
+
/**
|
|
4573
|
+
* <p>Names of the transit span in available languages.</p>
|
|
4574
|
+
* @public
|
|
4575
|
+
*/
|
|
4576
|
+
Names?: LocalizedString[] | undefined;
|
|
4577
|
+
/**
|
|
4578
|
+
* <p>2-3 letter Region code corresponding to the Span. This is either a province or a state.</p>
|
|
4579
|
+
* @public
|
|
4580
|
+
*/
|
|
4581
|
+
Region?: string | undefined;
|
|
4582
|
+
}
|
|
4583
|
+
/**
|
|
4584
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
4585
|
+
* @public
|
|
4586
|
+
*/
|
|
4587
|
+
export interface RouteTransitOverviewSummary {
|
|
4588
|
+
/**
|
|
4589
|
+
* <p>Distance of the entire leg.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
4590
|
+
* @public
|
|
4591
|
+
*/
|
|
4592
|
+
Distance: number | undefined;
|
|
4593
|
+
/**
|
|
4594
|
+
* <p>Duration of the entire leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4595
|
+
* @public
|
|
4596
|
+
*/
|
|
4597
|
+
Duration: number | undefined;
|
|
4598
|
+
}
|
|
4599
|
+
/**
|
|
4600
|
+
* <p>Summary including duration and distance for the travel portion of the leg only.</p>
|
|
4601
|
+
* @public
|
|
4602
|
+
*/
|
|
4603
|
+
export interface RouteTransitTravelOnlySummary {
|
|
4604
|
+
/**
|
|
4605
|
+
* <p>Duration of the travel portion of the transit leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4606
|
+
* @public
|
|
4607
|
+
*/
|
|
4608
|
+
Duration: number | undefined;
|
|
4609
|
+
}
|
|
4610
|
+
/**
|
|
4611
|
+
* <p>Summary of the transit leg.</p>
|
|
4612
|
+
* @public
|
|
4613
|
+
*/
|
|
4614
|
+
export interface RouteTransitSummary {
|
|
4615
|
+
/**
|
|
4616
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
4617
|
+
* @public
|
|
4618
|
+
*/
|
|
4619
|
+
Overview?: RouteTransitOverviewSummary | undefined;
|
|
4620
|
+
/**
|
|
4621
|
+
* <p>Summary including duration and distance for the travel portion of the leg only.</p>
|
|
4622
|
+
* @public
|
|
4623
|
+
*/
|
|
4624
|
+
TravelOnly?: RouteTransitTravelOnlySummary | undefined;
|
|
4625
|
+
}
|
|
4626
|
+
/**
|
|
4627
|
+
* <p>A step that must be performed during the travel portion of the leg.</p>
|
|
4628
|
+
* @public
|
|
4629
|
+
*/
|
|
4630
|
+
export interface RouteTransitTravelStep {
|
|
4631
|
+
/**
|
|
4632
|
+
* <p>Distance of the step.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
4633
|
+
* @public
|
|
4634
|
+
*/
|
|
4635
|
+
Distance?: number | undefined;
|
|
4636
|
+
/**
|
|
4637
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4638
|
+
* @public
|
|
4639
|
+
*/
|
|
4640
|
+
Duration: number | undefined;
|
|
4641
|
+
/**
|
|
4642
|
+
* <p>Offset in the leg geometry corresponding to the start of this step.</p>
|
|
4643
|
+
* @public
|
|
4644
|
+
*/
|
|
4645
|
+
GeometryOffset?: number | undefined;
|
|
4646
|
+
/**
|
|
4647
|
+
* <p>Brief description of the step in the requested language.</p>
|
|
4648
|
+
* @public
|
|
4649
|
+
*/
|
|
4650
|
+
Instruction?: string | undefined;
|
|
4651
|
+
/**
|
|
4652
|
+
* <p>Type of the step.</p>
|
|
4653
|
+
* @public
|
|
4654
|
+
*/
|
|
4655
|
+
Type: RouteTransitTravelStepType | undefined;
|
|
4656
|
+
}
|
|
4657
|
+
/**
|
|
4658
|
+
* <p>Populated when the Leg type is Transit, and provides additional information that is specific to public transit travel.</p>
|
|
4659
|
+
* @public
|
|
4660
|
+
*/
|
|
4661
|
+
export interface RouteTransitLegDetails {
|
|
4662
|
+
/**
|
|
4663
|
+
* <p>Steps of a leg that must be performed after the travel portion of the leg.</p>
|
|
4664
|
+
* @public
|
|
4665
|
+
*/
|
|
4666
|
+
AfterTravelSteps: RouteTransitAfterTravelStep[] | undefined;
|
|
4667
|
+
/**
|
|
4668
|
+
* <p>Details about the transit agency.</p>
|
|
4669
|
+
* @public
|
|
4670
|
+
*/
|
|
4671
|
+
Agency?: RouteTransitAgency | undefined;
|
|
4672
|
+
/**
|
|
4673
|
+
* <p>Details corresponding to the arrival for the leg.</p>
|
|
4674
|
+
* @public
|
|
4675
|
+
*/
|
|
4676
|
+
Arrival: RouteTransitArrival | undefined;
|
|
4677
|
+
/**
|
|
4678
|
+
* <p>List of required attributions to display.</p>
|
|
4679
|
+
* @public
|
|
4680
|
+
*/
|
|
4681
|
+
Attributions: RouteAttribution[] | undefined;
|
|
4682
|
+
/**
|
|
4683
|
+
* <p>Steps of a leg that must be performed before the travel portion of the leg.</p>
|
|
4684
|
+
* @public
|
|
4685
|
+
*/
|
|
4686
|
+
BeforeTravelSteps: RouteTransitBeforeTravelStep[] | undefined;
|
|
4687
|
+
/**
|
|
4688
|
+
* <p>Web links to external ticket booking services for the transit.</p>
|
|
4689
|
+
* @public
|
|
4690
|
+
*/
|
|
4691
|
+
BookingWebLinks: RouteWebLink[] | undefined;
|
|
4692
|
+
/**
|
|
4693
|
+
* <p>Details corresponding to the departure for the leg.</p>
|
|
4694
|
+
* @public
|
|
4695
|
+
*/
|
|
4696
|
+
Departure: RouteTransitDeparture | undefined;
|
|
4697
|
+
/**
|
|
4698
|
+
* <p>Incidents affecting this leg of the transit route.</p>
|
|
4699
|
+
* @public
|
|
4700
|
+
*/
|
|
4701
|
+
Incidents: RouteTransitIncident[] | undefined;
|
|
4702
|
+
/**
|
|
4703
|
+
* <p>Intermediate stops between departure and destination of the transit route.</p>
|
|
4704
|
+
* @public
|
|
4705
|
+
*/
|
|
4706
|
+
IntermediateStops: RouteTransitIntermediateStop[] | undefined;
|
|
4707
|
+
/**
|
|
4708
|
+
* <p>List of next departures that cover the same section of the route.</p>
|
|
4709
|
+
* @public
|
|
4710
|
+
*/
|
|
4711
|
+
NextDepartures: RouteTransitNextDeparture[] | undefined;
|
|
4712
|
+
/**
|
|
4713
|
+
* <p>List of notices that indicate issues that occurred during route calculation.</p>
|
|
4714
|
+
* @public
|
|
4715
|
+
*/
|
|
4716
|
+
Notices: RouteTransitNotice[] | undefined;
|
|
4717
|
+
/**
|
|
4718
|
+
* <p>Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option. Not populated when the TravelMode is <code>Transit</code> or <code>Intermodal</code>.</p>
|
|
4719
|
+
* @public
|
|
4720
|
+
*/
|
|
4721
|
+
PassThroughWaypoints: RoutePassThroughWaypoint[] | undefined;
|
|
4722
|
+
/**
|
|
4723
|
+
* <p>Spans that were computed for the requested SpanAdditionalFeatures. Not populated when the TravelMode is <code>Transit</code> or <code>Intermodal</code>.</p>
|
|
4724
|
+
* @public
|
|
4725
|
+
*/
|
|
4726
|
+
Spans: RouteTransitSpan[] | undefined;
|
|
4727
|
+
/**
|
|
4728
|
+
* <p>Summary of the transit leg.</p>
|
|
4729
|
+
* @public
|
|
4730
|
+
*/
|
|
4731
|
+
Summary?: RouteTransitSummary | undefined;
|
|
4732
|
+
/**
|
|
4733
|
+
* <p>Transport mode details for the transit leg.</p>
|
|
4734
|
+
* @public
|
|
4735
|
+
*/
|
|
4736
|
+
Transport: RouteTransitTransportModeDetails | undefined;
|
|
4737
|
+
/**
|
|
4738
|
+
* <p>Steps of a leg that must be performed during the travel portion of the leg.</p>
|
|
4739
|
+
* @public
|
|
4740
|
+
*/
|
|
4741
|
+
TravelSteps: RouteTransitTravelStep[] | undefined;
|
|
4742
|
+
}
|
|
4743
|
+
/**
|
|
4744
|
+
* <p>Details about the EV charge at the current step.</p>
|
|
4745
|
+
* @public
|
|
4746
|
+
*/
|
|
4747
|
+
export interface RouteChargeStepDetails {
|
|
4748
|
+
/**
|
|
4749
|
+
* <p>Estimated vehicle battery charge before this step (in kWh). </p>
|
|
4750
|
+
* @public
|
|
4751
|
+
*/
|
|
4752
|
+
ArrivalCharge?: number | undefined;
|
|
4753
|
+
/**
|
|
4754
|
+
* <p>Maximum charging power available to the vehicle.</p> <p> <b>Unit</b>: <code>KwH</code> </p>
|
|
4755
|
+
* @public
|
|
4756
|
+
*/
|
|
4757
|
+
ConsumablePower?: number | undefined;
|
|
4758
|
+
/**
|
|
4759
|
+
* <p>Details that are specific to a Charge step.</p> <p> <b>Unit</b>: <code>KwH</code> </p>
|
|
4760
|
+
* @public
|
|
4761
|
+
*/
|
|
4762
|
+
DesiredCharge?: number | undefined;
|
|
4763
|
+
}
|
|
4764
|
+
/**
|
|
4765
|
+
* <p>Steps of a leg that must be performed after the travel portion of the leg.</p>
|
|
4766
|
+
* @public
|
|
4767
|
+
*/
|
|
4768
|
+
export interface RouteVehicleAfterTravelStep {
|
|
4769
|
+
/**
|
|
4770
|
+
* <p>Details that are specific to a Charge step.</p> <p> <b>Unit</b>: <code>KwH </code> </p>
|
|
4771
|
+
* @public
|
|
4772
|
+
*/
|
|
4773
|
+
ChargeStepDetails?: RouteChargeStepDetails | undefined;
|
|
4774
|
+
/**
|
|
4775
|
+
* <p>Duration of the step.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
4776
|
+
* @public
|
|
4777
|
+
*/
|
|
4778
|
+
Duration: number | undefined;
|
|
4779
|
+
/**
|
|
4780
|
+
* <p>Brief description of the step in the requested language.</p> <note> <p>Only available when the TravelStepType is Default.</p> </note>
|
|
4781
|
+
* @public
|
|
4782
|
+
*/
|
|
4783
|
+
Instruction?: string | undefined;
|
|
4784
|
+
/**
|
|
4785
|
+
* <p>Type of the step.</p>
|
|
4786
|
+
* @public
|
|
4787
|
+
*/
|
|
4788
|
+
Type: RouteVehicleAfterTravelStepType | undefined;
|
|
4789
|
+
}
|
|
4790
|
+
/**
|
|
4791
|
+
* <p>Place details corresponding to the arrival or departure.</p>
|
|
4792
|
+
* @public
|
|
4793
|
+
*/
|
|
4794
|
+
export interface RouteVehiclePlace {
|
|
4795
|
+
/**
|
|
4796
|
+
* <p>The name of the place.</p>
|
|
4797
|
+
* @public
|
|
4798
|
+
*/
|
|
4799
|
+
Name?: string | undefined;
|
|
4800
|
+
/**
|
|
4801
|
+
* <p>Position provided in the request.</p>
|
|
4802
|
+
* @public
|
|
4803
|
+
*/
|
|
4804
|
+
OriginalPosition?: number[] | undefined;
|
|
4805
|
+
/**
|
|
4806
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
4807
|
+
* @public
|
|
4808
|
+
*/
|
|
4809
|
+
Position: number[] | undefined;
|
|
4810
|
+
/**
|
|
4811
|
+
* <p>Options to configure matching the provided position to a side of the street.</p>
|
|
4812
|
+
* @public
|
|
4813
|
+
*/
|
|
4814
|
+
SideOfStreet?: RouteSideOfStreet | undefined;
|
|
4815
|
+
/**
|
|
4816
|
+
* <p>Index of the waypoint in the request.</p>
|
|
4817
|
+
* @public
|
|
4818
|
+
*/
|
|
4819
|
+
WaypointIndex?: number | undefined;
|
|
4820
|
+
/**
|
|
4821
|
+
* <p>Details of the access point.</p>
|
|
4822
|
+
* @public
|
|
4823
|
+
*/
|
|
4824
|
+
AccessPointDetails?: RouteAccessPointDetails | undefined;
|
|
4825
|
+
/**
|
|
4826
|
+
* <p>Details about the station.</p>
|
|
4827
|
+
* @public
|
|
4828
|
+
*/
|
|
4829
|
+
StationDetails?: RouteStationDetails | undefined;
|
|
4830
|
+
/**
|
|
4831
|
+
* <p>The type of the place.</p>
|
|
4832
|
+
* @public
|
|
4833
|
+
*/
|
|
4834
|
+
Type?: RouteVehiclePlaceType | undefined;
|
|
4835
|
+
}
|
|
4836
|
+
/**
|
|
4837
|
+
* <p>Details corresponding to the arrival for a leg.</p>
|
|
4838
|
+
* @public
|
|
4839
|
+
*/
|
|
4840
|
+
export interface RouteVehicleArrival {
|
|
4841
|
+
/**
|
|
4842
|
+
* <p>Place details corresponding to the arrival.</p>
|
|
4843
|
+
* @public
|
|
4844
|
+
*/
|
|
4845
|
+
Place: RouteVehiclePlace | undefined;
|
|
4846
|
+
/**
|
|
4847
|
+
* <p>The arrival time.</p>
|
|
4848
|
+
* @public
|
|
4849
|
+
*/
|
|
4850
|
+
Time?: string | undefined;
|
|
4851
|
+
}
|
|
4852
|
+
/**
|
|
4853
|
+
* <p>Details corresponding to the departure for the leg.</p>
|
|
4854
|
+
* @public
|
|
4855
|
+
*/
|
|
4856
|
+
export interface RouteVehicleDeparture {
|
|
4857
|
+
/**
|
|
4858
|
+
* <p>Place details corresponding to the departure.</p>
|
|
4859
|
+
* @public
|
|
4860
|
+
*/
|
|
4861
|
+
Place: RouteVehiclePlace | undefined;
|
|
4862
|
+
/**
|
|
4863
|
+
* <p>The departure time.</p>
|
|
4864
|
+
* @public
|
|
4865
|
+
*/
|
|
4866
|
+
Time?: string | undefined;
|
|
4867
|
+
}
|
|
4868
|
+
/**
|
|
4869
|
+
* <p>Incidents corresponding to this leg of the route.</p>
|
|
4870
|
+
* @public
|
|
4871
|
+
*/
|
|
4872
|
+
export interface RouteVehicleIncident {
|
|
4873
|
+
/**
|
|
4874
|
+
* <p>Brief readable description of the incident.</p>
|
|
4875
|
+
* @public
|
|
4876
|
+
*/
|
|
4877
|
+
Description?: string | undefined;
|
|
4878
|
+
/**
|
|
4879
|
+
* <p>End timestamp of the incident.</p>
|
|
4880
|
+
* @public
|
|
4881
|
+
*/
|
|
4882
|
+
EndTime?: string | undefined;
|
|
4883
|
+
/**
|
|
4884
|
+
* <p>Severity of the incident Critical - The part of the route the incident affects is unusable. Major- Major impact on the leg duration, for example stop and go Minor- Minor impact on the leg duration, for example traffic jam Low - Low on duration, for example slightly increased traffic</p>
|
|
3179
4885
|
* @public
|
|
3180
4886
|
*/
|
|
3181
4887
|
Severity?: RouteVehicleIncidentSeverity | undefined;
|
|
@@ -3482,7 +5188,7 @@ export interface RouteVehicleSpan {
|
|
|
3482
5188
|
Zones?: number[] | undefined;
|
|
3483
5189
|
}
|
|
3484
5190
|
/**
|
|
3485
|
-
* <p>
|
|
5191
|
+
* <p>Summary including duration and distance for the entire leg.</p>
|
|
3486
5192
|
* @public
|
|
3487
5193
|
*/
|
|
3488
5194
|
export interface RouteVehicleOverviewSummary {
|
|
@@ -3492,17 +5198,17 @@ export interface RouteVehicleOverviewSummary {
|
|
|
3492
5198
|
*/
|
|
3493
5199
|
BestCaseDuration?: number | undefined;
|
|
3494
5200
|
/**
|
|
3495
|
-
* <p>Distance of the
|
|
5201
|
+
* <p>Distance of the entire leg.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
3496
5202
|
* @public
|
|
3497
5203
|
*/
|
|
3498
5204
|
Distance: number | undefined;
|
|
3499
5205
|
/**
|
|
3500
|
-
* <p>Duration of the
|
|
5206
|
+
* <p>Duration of the entire leg.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3501
5207
|
* @public
|
|
3502
5208
|
*/
|
|
3503
5209
|
Duration: number | undefined;
|
|
3504
5210
|
/**
|
|
3505
|
-
* <p>Duration of the
|
|
5211
|
+
* <p>Duration of the leg under typical traffic congestion.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3506
5212
|
* @public
|
|
3507
5213
|
*/
|
|
3508
5214
|
TypicalDuration?: number | undefined;
|
|
@@ -3523,7 +5229,7 @@ export interface RouteVehicleTravelOnlySummary {
|
|
|
3523
5229
|
*/
|
|
3524
5230
|
Duration: number | undefined;
|
|
3525
5231
|
/**
|
|
3526
|
-
* <p>Duration of the
|
|
5232
|
+
* <p>Duration of the leg under typical traffic congestion.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
3527
5233
|
* @public
|
|
3528
5234
|
*/
|
|
3529
5235
|
TypicalDuration?: number | undefined;
|
|
@@ -3805,89 +5511,6 @@ export interface RouteEnterHighwayStepDetails {
|
|
|
3805
5511
|
*/
|
|
3806
5512
|
TurnIntensity?: RouteTurnIntensity | undefined;
|
|
3807
5513
|
}
|
|
3808
|
-
/**
|
|
3809
|
-
* <p>Details related to the exit step.</p>
|
|
3810
|
-
* @public
|
|
3811
|
-
*/
|
|
3812
|
-
export interface RouteExitStepDetails {
|
|
3813
|
-
/**
|
|
3814
|
-
* <p>Name of the intersection, if applicable to the step.</p>
|
|
3815
|
-
* @public
|
|
3816
|
-
*/
|
|
3817
|
-
Intersection: LocalizedString[] | undefined;
|
|
3818
|
-
/**
|
|
3819
|
-
* <p>Exit to be taken.</p>
|
|
3820
|
-
* @public
|
|
3821
|
-
*/
|
|
3822
|
-
RelativeExit?: number | undefined;
|
|
3823
|
-
/**
|
|
3824
|
-
* <p>Steering direction for the step.</p>
|
|
3825
|
-
* @public
|
|
3826
|
-
*/
|
|
3827
|
-
SteeringDirection?: RouteSteeringDirection | undefined;
|
|
3828
|
-
/**
|
|
3829
|
-
* <p>Angle of the turn.</p>
|
|
3830
|
-
* @public
|
|
3831
|
-
*/
|
|
3832
|
-
TurnAngle?: number | undefined;
|
|
3833
|
-
/**
|
|
3834
|
-
* <p>Intensity of the turn.</p>
|
|
3835
|
-
* @public
|
|
3836
|
-
*/
|
|
3837
|
-
TurnIntensity?: RouteTurnIntensity | undefined;
|
|
3838
|
-
}
|
|
3839
|
-
/**
|
|
3840
|
-
* <p>Details that are specific to a ramp step.</p>
|
|
3841
|
-
* @public
|
|
3842
|
-
*/
|
|
3843
|
-
export interface RouteRampStepDetails {
|
|
3844
|
-
/**
|
|
3845
|
-
* <p>Name of the intersection, if applicable to the step.</p>
|
|
3846
|
-
* @public
|
|
3847
|
-
*/
|
|
3848
|
-
Intersection: LocalizedString[] | undefined;
|
|
3849
|
-
/**
|
|
3850
|
-
* <p>Steering direction for the step.</p>
|
|
3851
|
-
* @public
|
|
3852
|
-
*/
|
|
3853
|
-
SteeringDirection?: RouteSteeringDirection | undefined;
|
|
3854
|
-
/**
|
|
3855
|
-
* <p>Angle of the turn.</p>
|
|
3856
|
-
* @public
|
|
3857
|
-
*/
|
|
3858
|
-
TurnAngle?: number | undefined;
|
|
3859
|
-
/**
|
|
3860
|
-
* <p>Intensity of the turn.</p>
|
|
3861
|
-
* @public
|
|
3862
|
-
*/
|
|
3863
|
-
TurnIntensity?: RouteTurnIntensity | undefined;
|
|
3864
|
-
}
|
|
3865
|
-
/**
|
|
3866
|
-
* <p>Details related to the U-turn step.</p>
|
|
3867
|
-
* @public
|
|
3868
|
-
*/
|
|
3869
|
-
export interface RouteUTurnStepDetails {
|
|
3870
|
-
/**
|
|
3871
|
-
* <p>Name of the intersection, if applicable to the step.</p>
|
|
3872
|
-
* @public
|
|
3873
|
-
*/
|
|
3874
|
-
Intersection: LocalizedString[] | undefined;
|
|
3875
|
-
/**
|
|
3876
|
-
* <p>Steering direction for the step.</p>
|
|
3877
|
-
* @public
|
|
3878
|
-
*/
|
|
3879
|
-
SteeringDirection?: RouteSteeringDirection | undefined;
|
|
3880
|
-
/**
|
|
3881
|
-
* <p>Angle of the turn.</p>
|
|
3882
|
-
* @public
|
|
3883
|
-
*/
|
|
3884
|
-
TurnAngle?: number | undefined;
|
|
3885
|
-
/**
|
|
3886
|
-
* <p>Intensity of the turn.</p>
|
|
3887
|
-
* @public
|
|
3888
|
-
*/
|
|
3889
|
-
TurnIntensity?: RouteTurnIntensity | undefined;
|
|
3890
|
-
}
|
|
3891
5514
|
/**
|
|
3892
5515
|
* <p>Steps of a leg that correspond to the travel portion of the leg.</p>
|
|
3893
5516
|
* @public
|
|
@@ -4015,6 +5638,11 @@ export interface RouteZone {
|
|
|
4015
5638
|
* @public
|
|
4016
5639
|
*/
|
|
4017
5640
|
export interface RouteVehicleLegDetails {
|
|
5641
|
+
/**
|
|
5642
|
+
* <p>Steps of a leg that must be performed after the travel portion of the leg.</p>
|
|
5643
|
+
* @public
|
|
5644
|
+
*/
|
|
5645
|
+
AfterTravelSteps: RouteVehicleAfterTravelStep[] | undefined;
|
|
4018
5646
|
/**
|
|
4019
5647
|
* <p>Details corresponding to the arrival for the leg.</p>
|
|
4020
5648
|
* @public
|
|
@@ -4116,6 +5744,21 @@ export interface RouteLeg {
|
|
|
4116
5744
|
* @public
|
|
4117
5745
|
*/
|
|
4118
5746
|
VehicleLegDetails?: RouteVehicleLegDetails | undefined;
|
|
5747
|
+
/**
|
|
5748
|
+
* <p>Details related to the rental leg.</p> <note> <p>Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p> </note>
|
|
5749
|
+
* @public
|
|
5750
|
+
*/
|
|
5751
|
+
RentalLegDetails?: RouteRentalLegDetails | undefined;
|
|
5752
|
+
/**
|
|
5753
|
+
* <p>Details related to the taxi leg.</p> <note> <p>Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p> </note>
|
|
5754
|
+
* @public
|
|
5755
|
+
*/
|
|
5756
|
+
TaxiLegDetails?: RouteTaxiLegDetails | undefined;
|
|
5757
|
+
/**
|
|
5758
|
+
* <p>Details related to the transit leg.</p>
|
|
5759
|
+
* @public
|
|
5760
|
+
*/
|
|
5761
|
+
TransitLegDetails?: RouteTransitLegDetails | undefined;
|
|
4119
5762
|
}
|
|
4120
5763
|
/**
|
|
4121
5764
|
* <p>Important labels including names and route numbers that differentiate the current route from the alternatives presented.</p>
|
|
@@ -4728,7 +6371,7 @@ export interface OptimizeWaypointsRequest {
|
|
|
4728
6371
|
*/
|
|
4729
6372
|
TravelModeOptions?: WaypointOptimizationTravelModeOptions | undefined;
|
|
4730
6373
|
/**
|
|
4731
|
-
* <p>List of waypoints between the <code>Origin</code> and <code>Destination</code
|
|
6374
|
+
* <p>List of waypoints between the <code>Origin</code> and <code>Destination</code>, in World Geodetic System (WGS 84) format: [longitude, latitude].</p> <p>The maximum number of waypoints allowed per request:</p> <ul> <li> <p>Maximum 50 waypoints per request</p> </li> <li> <p>Maximum 20 waypoints when using constraints (<code>AccessHours</code>, <code>AppointmentTime</code>, <code>ServiceDuration</code>, <code>Heading</code>, <code>SideOfStreet</code>, <code>Before</code>)</p> </li> </ul>
|
|
4732
6375
|
* @public
|
|
4733
6376
|
*/
|
|
4734
6377
|
Waypoints?: WaypointOptimizationWaypoint[] | undefined;
|