@aws-sdk/client-geo-routes 3.1058.0 → 3.1060.0

package/dist-types/GeoRoutes.d.ts

@@ -38,7 +38,7 @@ export interface GeoRoutes {
     snapToRoads(args: SnapToRoadsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SnapToRoadsCommandOutput) => void): void;
 }
 /**
- * <p>With the Amazon Location Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information.</p> <p>Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:</p> <ul> <li> <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn directions</p> </li> <li> <p>Multi-point route optimization to minimize travel time or distance</p> </li> <li> <p>Route matrices for efficient multi-destination planning</p> </li> <li> <p>Isoline calculations to determine reachable areas within specified time or distance thresholds</p> </li> <li> <p>Map-matching to align GPS traces with the road network</p> </li> </ul>
+ * <p>With the Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information. Key features include:</p> <ul> <li> <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn directions. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_CalculateRoutes.html">CalculateRoutes</a>.</p> </li> <li> <p>Multi-point route optimization to minimize travel time or distance. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_OptimizeWaypoints.html">OptimizeWaypoints</a>.</p> </li> <li> <p>Route matrices for efficient multi-destination planning. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_CalculateRouteMatrix.html">CalculateRouteMatrix</a>.</p> </li> <li> <p>Isoline calculations to determine reachable areas within specified time or distance thresholds. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_CalculateIsolines.html">CalculateIsolines</a>.</p> </li> <li> <p>Map-matching to align GPS traces with the road network. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_SnapToRoads.html">SnapToRoads</a>.</p> </li> </ul>
  * @public
  */
 export declare class GeoRoutes extends GeoRoutesClient implements GeoRoutes {

package/dist-types/GeoRoutesClient.d.ts

@@ -173,7 +173,7 @@ export type GeoRoutesClientResolvedConfigType = __SmithyResolvedConfiguration<__
 export interface GeoRoutesClientResolvedConfig extends GeoRoutesClientResolvedConfigType {
 }
 /**
- * <p>With the Amazon Location Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information.</p> <p>Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:</p> <ul> <li> <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn directions</p> </li> <li> <p>Multi-point route optimization to minimize travel time or distance</p> </li> <li> <p>Route matrices for efficient multi-destination planning</p> </li> <li> <p>Isoline calculations to determine reachable areas within specified time or distance thresholds</p> </li> <li> <p>Map-matching to align GPS traces with the road network</p> </li> </ul>
+ * <p>With the Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information. Key features include:</p> <ul> <li> <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn directions. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_CalculateRoutes.html">CalculateRoutes</a>.</p> </li> <li> <p>Multi-point route optimization to minimize travel time or distance. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_OptimizeWaypoints.html">OptimizeWaypoints</a>.</p> </li> <li> <p>Route matrices for efficient multi-destination planning. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_CalculateRouteMatrix.html">CalculateRouteMatrix</a>.</p> </li> <li> <p>Isoline calculations to determine reachable areas within specified time or distance thresholds. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_CalculateIsolines.html">CalculateIsolines</a>.</p> </li> <li> <p>Map-matching to align GPS traces with the road network. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_SnapToRoads.html">SnapToRoads</a>.</p> </li> </ul>
  * @public
  */
 export declare class GeoRoutesClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, GeoRoutesClientResolvedConfig> {

package/dist-types/commands/CalculateIsolinesCommand.d.ts

@@ -119,7 +119,7 @@ declare const CalculateIsolinesCommand_base: {
  *     UTurns: true || false,
  *     ZoneCategories: [ // IsolineAvoidanceZoneCategoryList
  *       { // IsolineAvoidanceZoneCategory
- *         Category: "STRING_VALUE",
+ *         Category: "CongestionPricing" || "Environmental" || "Vignette",
  *       },
  *     ],
  *   },
@@ -133,11 +133,11 @@ declare const CalculateIsolinesCommand_base: {
  *       NameHint: "STRING_VALUE",
  *       OnRoadThreshold: Number("long"),
  *       Radius: Number("long"),
- *       Strategy: "STRING_VALUE",
+ *       Strategy: "MatchAny" || "MatchMostSignificantRoad",
  *     },
  *     SideOfStreet: { // IsolineSideOfStreetOptions
  *       Position: "<Position>", // required
- *       UseWith: "STRING_VALUE",
+ *       UseWith: "AnyStreet" || "DividedStreetOnly",
  *     },
  *   },
  *   IsolineGeometryFormat: "FlexiblePolyline" || "Simple",
@@ -146,8 +146,8 @@ declare const CalculateIsolinesCommand_base: {
  *     MaxResolution: Number("long"),
  *   },
  *   Key: "STRING_VALUE",
- *   OptimizeIsolineFor: "STRING_VALUE",
- *   OptimizeRoutingFor: "STRING_VALUE",
+ *   OptimizeIsolineFor: "AccurateCalculation" || "BalancedCalculation" || "FastCalculation",
+ *   OptimizeRoutingFor: "FastestRoute" || "ShortestRoute",
  *   Origin: "<Position>",
  *   OriginOptions: { // IsolineOriginOptions
  *     AvoidActionsForDistance: Number("long"),
@@ -156,11 +156,11 @@ declare const CalculateIsolinesCommand_base: {
  *       NameHint: "STRING_VALUE",
  *       OnRoadThreshold: Number("long"),
  *       Radius: Number("long"),
- *       Strategy: "STRING_VALUE",
+ *       Strategy: "MatchAny" || "MatchMostSignificantRoad",
  *     },
  *     SideOfStreet: {
  *       Position: "<Position>", // required
- *       UseWith: "STRING_VALUE",
+ *       UseWith: "AnyStreet" || "DividedStreetOnly",
  *     },
  *   },
  *   Thresholds: { // IsolineThresholds
@@ -173,12 +173,12 @@ declare const CalculateIsolinesCommand_base: {
  *   },
  *   Traffic: { // IsolineTrafficOptions
  *     FlowEventThresholdOverride: Number("long"),
- *     Usage: "STRING_VALUE",
+ *     Usage: "IgnoreTrafficData" || "UseTrafficData",
  *   },
- *   TravelMode: "STRING_VALUE",
+ *   TravelMode: "Car" || "Pedestrian" || "Scooter" || "Truck",
  *   TravelModeOptions: { // IsolineTravelModeOptions
  *     Car: { // IsolineCarOptions
- *       EngineType: "STRING_VALUE",
+ *       EngineType: "Electric" || "InternalCombustion" || "PluginHybrid",
  *       LicensePlate: { // IsolineVehicleLicensePlate
  *         LastCharacter: "STRING_VALUE",
  *       },
@@ -186,7 +186,7 @@ declare const CalculateIsolinesCommand_base: {
  *       Occupancy: Number("int"),
  *     },
  *     Scooter: { // IsolineScooterOptions
- *       EngineType: "STRING_VALUE",
+ *       EngineType: "Electric" || "InternalCombustion" || "PluginHybrid",
  *       LicensePlate: {
  *         LastCharacter: "STRING_VALUE",
  *       },
@@ -195,10 +195,10 @@ declare const CalculateIsolinesCommand_base: {
  *     },
  *     Truck: { // IsolineTruckOptions
  *       AxleCount: Number("int"),
- *       EngineType: "STRING_VALUE",
+ *       EngineType: "Electric" || "InternalCombustion" || "PluginHybrid",
  *       GrossWeight: Number("long"),
  *       HazardousCargos: [ // IsolineHazardousCargoTypeList
- *         "STRING_VALUE",
+ *         "Combustible" || "Corrosive" || "Explosive" || "Flammable" || "Gas" || "HarmfulToWater" || "Organic" || "Other" || "Poison" || "PoisonousInhalation" || "Radioactive",
  *       ],
  *       Height: Number("long"),
  *       HeightAboveFirstAxle: Number("long"),
@@ -215,7 +215,7 @@ declare const CalculateIsolinesCommand_base: {
  *         AxleCount: Number("int"),
  *         TrailerCount: Number("int"),
  *       },
- *       TruckType: "STRING_VALUE",
+ *       TruckType: "LightTruck" || "StraightTruck" || "Tractor",
  *       TunnelRestrictionCode: "STRING_VALUE",
  *       WeightPerAxle: Number("long"),
  *       WeightPerAxleGroup: { // WeightPerAxleGroup

package/dist-types/commands/CalculateRouteMatrixCommand.d.ts

@@ -76,7 +76,7 @@ declare const CalculateRouteMatrixCommand_base: {
  *     UTurns: true || false,
  *     ZoneCategories: [ // RouteMatrixAvoidanceZoneCategoryList
  *       { // RouteMatrixAvoidanceZoneCategory
- *         Category: "STRING_VALUE",
+ *         Category: "CongestionPricing" || "Environmental" || "Vignette",
  *       },
  *     ],
  *   },
@@ -91,13 +91,13 @@ declare const CalculateRouteMatrixCommand_base: {
  *           NameHint: "STRING_VALUE",
  *           OnRoadThreshold: Number("long"),
  *           Radius: Number("long"),
- *           Strategy: "STRING_VALUE",
+ *           Strategy: "MatchAny" || "MatchMostSignificantRoad",
  *         },
  *         SideOfStreet: { // RouteMatrixSideOfStreetOptions
  *           Position: [ // required
  *             Number("double"),
  *           ],
- *           UseWith: "STRING_VALUE",
+ *           UseWith: "AnyStreet" || "DividedStreetOnly",
  *         },
  *       },
  *       Position: "<Position>", // required
@@ -109,7 +109,7 @@ declare const CalculateRouteMatrixCommand_base: {
  *     ],
  *   },
  *   Key: "STRING_VALUE",
- *   OptimizeRoutingFor: "STRING_VALUE",
+ *   OptimizeRoutingFor: "FastestRoute" || "ShortestRoute",
  *   Origins: [ // RouteMatrixOriginList // required
  *     { // RouteMatrixOrigin
  *       Options: { // RouteMatrixOriginOptions
@@ -119,11 +119,11 @@ declare const CalculateRouteMatrixCommand_base: {
  *           NameHint: "STRING_VALUE",
  *           OnRoadThreshold: Number("long"),
  *           Radius: Number("long"),
- *           Strategy: "STRING_VALUE",
+ *           Strategy: "MatchAny" || "MatchMostSignificantRoad",
  *         },
  *         SideOfStreet: {
  *           Position: "<Position>", // required
- *           UseWith: "STRING_VALUE",
+ *           UseWith: "AnyStreet" || "DividedStreetOnly",
  *         },
  *       },
  *       Position: "<Position>", // required
@@ -152,9 +152,9 @@ declare const CalculateRouteMatrixCommand_base: {
  *   },
  *   Traffic: { // RouteMatrixTrafficOptions
  *     FlowEventThresholdOverride: Number("long"),
- *     Usage: "STRING_VALUE",
+ *     Usage: "IgnoreTrafficData" || "UseTrafficData",
  *   },
- *   TravelMode: "STRING_VALUE",
+ *   TravelMode: "Car" || "Pedestrian" || "Scooter" || "Truck",
  *   TravelModeOptions: { // RouteMatrixTravelModeOptions
  *     Car: { // RouteMatrixCarOptions
  *       LicensePlate: { // RouteMatrixVehicleLicensePlate
@@ -174,7 +174,7 @@ declare const CalculateRouteMatrixCommand_base: {
  *       AxleCount: Number("int"),
  *       GrossWeight: Number("long"),
  *       HazardousCargos: [ // RouteMatrixHazardousCargoTypeList
- *         "STRING_VALUE",
+ *         "Combustible" || "Corrosive" || "Explosive" || "Flammable" || "Gas" || "HarmfulToWater" || "Organic" || "Other" || "Poison" || "PoisonousInhalation" || "Radioactive",
  *       ],
  *       Height: Number("long"),
  *       KpraLength: Number("long"),
@@ -188,7 +188,7 @@ declare const CalculateRouteMatrixCommand_base: {
  *       Trailer: { // RouteMatrixTrailerOptions
  *         TrailerCount: Number("int"),
  *       },
- *       TruckType: "STRING_VALUE",
+ *       TruckType: "LightTruck" || "StraightTruck" || "Tractor",
  *       TunnelRestrictionCode: "STRING_VALUE",
  *       WeightPerAxle: Number("long"),
  *       WeightPerAxleGroup: { // WeightPerAxleGroup
@@ -212,7 +212,7 @@ declare const CalculateRouteMatrixCommand_base: {
  * //       { // RouteMatrixEntry
  * //         Distance: Number("long"), // required
  * //         Duration: Number("long"), // required
- * //         Error: "STRING_VALUE",
+ * //         Error: "NoMatch" || "NoMatchDestination" || "NoMatchOrigin" || "NoRoute" || "OutOfBounds" || "OutOfBoundsDestination" || "OutOfBoundsOrigin" || "Other" || "Violation",
  * //       },
  * //     ],
  * //   ],