AWS cli documentation change
Summary
Updated AWS CLI documentation for the CalculateIsolines command with extensive improvements to parameter descriptions, examples, and clarifications about routing preferences, geometry formats, travel modes, and traffic considerations.
Security assessment
The changes are purely documentation improvements with no evidence of addressing security vulnerabilities. Updates include better explanations of routing parameters, geometry formats, travel modes, and traffic options. The only security-relevant change is clarifying that API keys are used for authorization, but this is standard documentation, not addressing a security issue.
Diff
diff --git a/cli/latest/reference/geo-routes/calculate-isolines.md b/cli/latest/reference/geo-routes/calculate-isolines.md index bed8dc542..757e122be 100644 --- a//cli/latest/reference/geo-routes/calculate-isolines.md +++ b//cli/latest/reference/geo-routes/calculate-isolines.md @@ -15 +15 @@ - * [AWS CLI 2.34.21 Command Reference](../../index.html) » + * [AWS CLI 2.34.23 Command Reference](../../index.html) » @@ -59 +59,15 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -Use the `CalculateIsolines` action to find service areas that can be reached in a given threshold of time, distance. +Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time. + +Isolines (also known as isochrones for time-based calculations) are useful for various applications including: + + * Service area visualization - Show customers the area you can serve within promised delivery times + * Site selection - Analyze potential business locations based on population within travel distance + * Site selection - Determine areas that can be reached within specified response times + + + +### Note + +Route preferences such as avoiding toll roads or ferries are treated as preferences rather than absolute restrictions. If a viable route cannot be calculated while honoring all preferences, some may be ignored. + +For more information, see [Calculate isolines](https://docs.aws.amazon.com/location/latest/developerguide/calculate-isolines.html) in the _Amazon Location Service Developer Guide_ . @@ -112 +126 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/geo-ro -> Features that are allowed while calculating an isoline. +> Enables special road types or features that should be considered for routing even if they might be restricted by default for the selected travel mode. These include high-occupancy vehicle and toll lanes. @@ -116 +130 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/geo-ro ->> Allow Hot (High Occupancy Toll) lanes while calculating an isoline. +>> When true, allows the use of HOT (high-occupancy toll) lanes, which may affect travel times and reachable areas. @@ -122 +136 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/geo-ro ->> Allow Hov (High Occupancy vehicle) lanes while calculating an isoline. +>> When true, allows the use of HOV (high-occupancy vehicle) lanes, which may affect travel times and reachable areas. @@ -143 +157 @@ JSON Syntax: -> Time of arrival at the destination. +> Determine areas from which `Destination` can be reached by this time, taking into account predicted traffic conditions and working backward to account for congestion patterns. This attribute cannot be used together with `DepartureTime` or `DepartNow` . Specified as an ISO-8601 timestamp with timezone offset. @@ -161 +175 @@ JSON Syntax: -> Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can’t be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. +> Specifies road types, features, or areas to avoid (if possible) when calculating reachable areas. These are treated as preferences rather than strict constraints—if a route cannot be calculated without using an avoided feature, that avoidance preference may be ignored. @@ -165 +179 @@ JSON Syntax: ->> Areas to be avoided. +>> Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists. @@ -169 +183 @@ JSON Syntax: ->>> The area to be avoided. +>>> Defines an area to avoid when calculating routes. Consists of a primary geometry to avoid, with the ability to specify exception areas within that geometry where travel is permitted. @@ -173 +187 @@ JSON Syntax: ->>>> Exceptions to the provided avoidance geometry, to be included while calculating an isoline. +>>>> Areas within the primary avoidance geometry where travel is allowed. For example, you might want to avoid a neighborhood but allow travel on a major road that passes through it. @@ -177 +191 @@ JSON Syntax: ->>>>> The avoidance geometry, to be included while calculating an isoline. +>>>>> Defines an area to avoid during calculations using one of several supported geometry types. The service will prefer routes that avoid these areas when possible. @@ -181 +195 @@ JSON Syntax: ->>>>>> 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. +>>>>>> A rectangular area defined by its southwest and northeast corners: `[min longitude, min latitude, max longitude, max latitude]` . @@ -194 +208 @@ JSON Syntax: ->>>>>> Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor. +>>>>>> A buffer zone around a line, defined by a series of coordinates and a radius in meters. @@ -227 +241 @@ JSON Syntax: ->>>>>> A list of Polygon will be excluded for calculating isolines, the list can only contain 1 polygon. +>>>>>> A polygon defined by a list of coordinate rings. The first ring defines the outer boundary; subsequent rings will be ignored. @@ -257 +271 @@ JSON Syntax: ->>>>>> Geometry defined as an encoded corridor – a polyline with a radius that defines the width of the corridor. For more information on polyline encoding, see <https://github.com/heremaps/flexiblepolyline/blob/master/README.md> . +>>>>>> A buffer zone around a compressed polyline, defined by an encoded polyline string and a radius in meters. For more information on polyline encoding, see <https://github.com/aws-geospatial/polyline> . @@ -277 +291 @@ JSON Syntax: ->>>>>>>> **Unit** : `Meters` +>>>>>>>> **Unit** : `meters` @@ -281 +295 @@ JSON Syntax: ->>>>>> A list of PolylinePolygon’s that are excluded for calculating isolines, the list can only contain 1 polygon. For more information on polyline encoding, see <https://github.com/heremaps/flexiblepolyline/blob/master/README.md> . +>>>>>> A polygon defined by encoded polyline strings. The first string defines the outer boundary; subsequent strings will be ignored. For more information on polyline encoding, see <https://github.com/aws-geospatial/polyline> . @@ -300 +314 @@ JSON Syntax: ->>>> Geometry of the area to be avoided. +>>>> The primary area to avoid, specified using a bounding box, corridor, polygon, or polyline corridor. @@ -304 +318 @@ JSON Syntax: ->>>>> 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. +>>>>> A rectangular area defined by its southwest and northeast corners: `[min longitude, min latitude, max longitude, max latitude]` . @@ -317 +331 @@ JSON Syntax: ->>>>> Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor. +>>>>> A buffer zone around a line, defined by a series of coordinates and a radius in meters. @@ -350 +364 @@ JSON Syntax: ->>>>> A list of Polygon will be excluded for calculating isolines, the list can only contain 1 polygon. +>>>>> A polygon defined by a list of coordinate rings. The first ring defines the outer boundary; subsequent rings will be ignored. @@ -380 +394 @@ JSON Syntax: ->>>>> Geometry defined as an encoded corridor – a polyline with a radius that defines the width of the corridor. For more information on polyline encoding, see <https://github.com/heremaps/flexiblepolyline/blob/master/README.md> . +>>>>> A buffer zone around a compressed polyline, defined by an encoded polyline string and a radius in meters. For more information on polyline encoding, see <https://github.com/aws-geospatial/polyline> . @@ -400 +414 @@ JSON Syntax: ->>>>>>> **Unit** : `Meters` +>>>>>>> **Unit** : `meters` @@ -404 +418 @@ JSON Syntax: ->>>>> A list of PolylinePolygon’s that are excluded for calculating isolines, the list can only contain 1 polygon. For more information on polyline encoding, see <https://github.com/heremaps/flexiblepolyline/blob/master/README.md> . +>>>>> A polygon defined by encoded polyline strings. The first string defines the outer boundary; subsequent strings will be ignored. For more information on polyline encoding, see <https://github.com/aws-geospatial/polyline> . @@ -423 +437 @@ JSON Syntax: ->> Avoid car-shuttle-trains while calculating an isoline. +>> Indicates a preference to avoid car shuttle trains (auto trains) where possible. These may still be included if no reasonable alternative route exists. @@ -427 +441 @@ JSON Syntax: ->> Avoid controlled access highways while calculating an isoline. +>> Indicates a preference to avoid controlled-access highways (such as interstate highways or motorways) where possible. If a viable route cannot be calculated using only local roads, controlled-access highways may still be included. @@ -431 +445 @@ JSON Syntax: ->> Avoid dirt roads while calculating an isoline. +>> Indicates a preference to avoid unpaved or dirt roads where possible. Routes may still include dirt roads if no reasonable paved alternative exists. @@ -435 +449 @@ JSON Syntax: ->> Avoid ferries while calculating an isoline. +>> Indicates a preference to avoid ferries where possible. If a viable route cannot be calculated without using ferries, they may still be included. @@ -439 +453 @@ JSON Syntax: ->> Avoid roads that have seasonal closure while calculating an isoline. +>> Indicates a preference to avoid roads that may be subject to seasonal closures where possible. These roads may still be included if no reasonable year-round alternative exists. @@ -443 +457 @@ JSON Syntax: ->> Avoids roads where the specified toll transponders are the only mode of payment. +>> Indicates a preference to avoid toll roads where possible. If a viable route cannot be calculated without using toll roads, they may still be included. @@ -447 +461 @@ JSON Syntax: ->> Avoids roads where the specified toll transponders are the only mode of payment. +>> Indicates a preference to avoid roads that require electronic toll collection transponders where possible. These roads may still be included if no viable alternative route exists. @@ -451 +465 @@ JSON Syntax: ->> Truck road type identifiers. `BK1` through `BK4` apply only to Sweden. `A2,A4,B2,B4,C,D,ET2,ET4` apply only to Mexico. +>> For truck travel modes, indicates specific road classification types in Sweden (`BK1` through `BK4` ) and Mexico (`A2, A4, B2, B4, C, D, ET2, ET4` ) to avoid where possible. These road types may still be used if no reasonable alternative exists. @@ -475 +489 @@ JSON Syntax: ->> Avoid tunnels while calculating an isoline. +>> Indicates a preference to avoid tunnels where possible. If a viable route cannot be calculated without using tunnels, they may still be included. @@ -479 +493 @@ JSON Syntax: ->> Avoid U-turns for calculation on highways and motorways. +>> Indicates a preference to avoid U-turns where possible. U-turns may still be included if necessary to reach certain areas or when no reasonable alternative exists. @@ -483 +497 @@ JSON Syntax: ->> Zone categories to be avoided. +>> Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists. @@ -494 +508 @@ JSON Syntax: ->>> Zone category to be avoided. +>>> Types of regulated zones that may affect routing. @@ -498 +512 @@ JSON Syntax: ->>>> Zone category to be avoided. +>>>> The type of regulated zone: `CongestionPricing` for toll zones based on traffic levels, `Environmental` for low-emission zones, or `Vignette` for areas requiring special permits or stickers. @@ -585 +599 @@ JSON Syntax: -> Uses the current time as the time of departure. +> When true, uses the current time as the departure time and takes current traffic conditions into account. This attribute cannot be used together with `DepartureTime` or `ArrivalTime` . @@ -589 +603 @@ JSON Syntax: -> Time of departure from thr origin. +> Determine areas that can be reached when departing at this time, taking into account predicted traffic conditions. This attribute cannot be used together with `ArrivalTime` or `DepartNow` . Specified as an ISO-8601 timestamp with timezone offset. @@ -607 +621 @@ JSON Syntax: -> The final position for the route. In the World Geodetic System (WGS 84) format: `[longitude, latitude]` . +> An optional destination point, specified as `[longitude, latitude]` coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either `Origin` or `Destination` must be provided. @@ -626 +640 @@ Syntax: -> Destination related options. +> Options that control how the destination point is matched to the road network and how routes can approach it. These options help improve travel time accuracy by accounting for real-world access to the destination. @@ -630 +644 @@ Syntax: ->> Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination. +>> The distance in meters from the destination point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the endpoint. @@ -641 +655 @@ Syntax: ->> GPS Heading at the position. +>> The initial direction of travel in degrees (0-360, where 0 is north). This can affect which road segments are considered accessible from the starting point. @@ -652 +666 @@ Syntax: ->> Options to configure matching the provided position to the road network. +>> Controls how the destination point is matched to the road network, including search radius and name-based matching preferences. @@ -656 +670 @@ Syntax: ->>> Attempts to match the provided position to a road similar to the provided name. +>>> The expected street name near the point. Helps disambiguate matching when multiple roads are within range. @@ -660 +674 @@ Syntax: ->>> If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad. +>>> The maximum distance in meters that a point can be from a road while still being considered “on” that road. Points further than this distance require explicit matching. @@ -673 +687 @@ Syntax: ->>> Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy. +>>> The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified `Strategy` @@ -675 +689 @@ Syntax: ->>>> **Unit** : `Meters` +>>>> **Unit** : `meters` @@ -686 +700 @@ Syntax: ->>> Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road. +>>> Determines how points are matched to the road network. `MatchAny` finds the nearest viable road segment, while `MatchMostSignificantRoad` prioritizes major roads. @@ -697 +711 @@ Syntax: ->> Options to configure matching the provided position to a side of the street. +>> Specifies which side of the street should be considered accessible, which is important when building entrances or parking access points are only reachable from one side of the road. @@ -701 +715 @@ Syntax: ->>> Position defined as `[longitude, latitude]` . +>>> The `[longitude, latitude]` coordinates of the point that should be matched to a specific side of the street. @@ -714 +728 @@ Syntax: ->>> Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position. +>>> Controls whether side-of-street matching is applied to any street (`AnyStreet` ) or only to divided roads (`DividedStreetOnly` ). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don’t account for necessary U-turns or detours to reach the correct side. @@ -716 +730 @@ Syntax: ->>> Default Value: `DividedStreetOnly` +>>> Default value: `DividedStreetOnly` @@ -754 +768 @@ JSON Syntax: -> Default Value:`FlexiblePolyline` +> Default value:`FlexiblePolyline` @@ -765 +779 @@ JSON Syntax: -> Defines the granularity of the returned Isoline. +> Controls the detail level of the generated isolines. Higher granularity produces smoother shapes but requires more processing time and results in larger responses. @@ -769 +783 @@ JSON Syntax: ->> Maximum number of points of returned Isoline. +>> The maximum number of points used to define each isoline. Higher values create smoother, more detailed shapes. @@ -779 +793 @@ JSON Syntax: ->> Maximum resolution of the returned isoline. +>> The maximum distance in meters between points along the isoline. Smaller values create more detailed shapes. @@ -807 +821 @@ JSON Syntax: -> Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. +> An Amazon Location Service API Key with access to this action. If omitted, the request must be signed using Signature Version 4. @@ -818 +832 @@ JSON Syntax: -> Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance. +> Controls the trade-off between calculation speed and isoline precision. Choose `FastCalculation` for quicker results with less detail, `AccurateCalculation` for more precise results, or `BalancedCalculation` for a middle ground. @@ -820 +834 @@ JSON Syntax: -> Default Value: `BalancedCalculation` +> Default value: `BalancedCalculation` @@ -832 +846 @@ JSON Syntax: -> Specifies the optimization criteria for calculating a route.