Skip to content

Commit 5c0e234

Browse files
author
awstools
committed
feat(client-location): Amazon Location Service now includes a MaxResults parameter for ListGeofences requests.
1 parent 9b91388 commit 5c0e234

15 files changed

+684
-583
lines changed

‎clients/client-location/src/Location.ts

+65-54
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,10 @@ export class Location extends LocationClient {
362362
* <p>Geofence evaluation uses the given device position. It does not account for the
363363
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
364364
* </note>
365+
* <note>
366+
* <p>The <code>DeviceID</code> is used as a string to represent the device. You do not
367+
* need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p>
368+
* </note>
365369
*/
366370
public batchEvaluateGeofences(
367371
args: BatchEvaluateGeofencesCommandInput,
@@ -519,8 +523,9 @@ export class Location extends LocationClient {
519523
* <ul>
520524
* <li>
521525
* <p>
522-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code>
523-
* or <code>DepartNow</code>. This calculates a route based on predictive traffic
526+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
527+
* departure time</a> using either <code>DepartureTime</code> or
528+
* <code>DepartNow</code>. This calculates a route based on predictive traffic
524529
* data at the given time. </p>
525530
* <note>
526531
* <p>You can't specify both <code>DepartureTime</code> and
@@ -530,9 +535,10 @@ export class Location extends LocationClient {
530535
* </li>
531536
* <li>
532537
* <p>
533-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
534-
* mode used to calculate the routes. This also lets you specify additional route
535-
* preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
538+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
539+
* mode</a> using TravelMode sets the transportation mode used to calculate
540+
* the routes. This also lets you specify additional route preferences in
541+
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
536542
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
537543
* </li>
538544
* </ul>
@@ -568,30 +574,31 @@ export class Location extends LocationClient {
568574

569575
/**
570576
* <p>
571-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a
572-
* route matrix</a> given the following required parameters:
573-
* <code>DeparturePositions</code> and <code>DestinationPositions</code>.
574-
* <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
577+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a route
578+
* matrix</a> given the following required parameters:
579+
* <code>DeparturePositions</code> and <code>DestinationPositions</code>.
580+
* <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
575581
* travel distance from each departure position to each destination position in the
576-
* request. For example, given departure positions A and B, and destination positions
577-
* X and Y, <code>CalculateRouteMatrix</code> will return time and distance for routes
578-
* from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned
579-
* (and routes calculated) will be the number of <code>DeparturePositions</code>
580-
* times the number of <code>DestinationPositions</code>.</p>
582+
* request. For example, given departure positions A and B, and destination positions X and
583+
* Y, <code>CalculateRouteMatrix</code> will return time and distance for routes from A to
584+
* X, A to Y, B to X, and B to Y (in that order). The number of results returned (and
585+
* routes calculated) will be the number of <code>DeparturePositions</code> times the
586+
* number of <code>DestinationPositions</code>.</p>
581587
* <note>
582-
* <p>Your account is charged for each route calculated, not the number of requests.</p>
588+
* <p>Your account is charged for each route calculated, not the number of
589+
* requests.</p>
583590
* </note>
584591
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
585-
* route calculator resource</a>.</p>
592+
* route calculator resource</a>.</p>
586593
* <p>By default, a request that doesn't specify a departure time uses the best time of day
587594
* to travel with the best traffic conditions when calculating routes.</p>
588595
* <p>Additional options include:</p>
589596
* <ul>
590597
* <li>
591598
* <p>
592-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">
593-
* Specifying a departure time</a> using either <code>DepartureTime</code>
594-
* or <code>DepartNow</code>. This calculates routes based on predictive traffic
599+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html"> Specifying a
600+
* departure time</a> using either <code>DepartureTime</code> or
601+
* <code>DepartNow</code>. This calculates routes based on predictive traffic
595602
* data at the given time. </p>
596603
* <note>
597604
* <p>You can't specify both <code>DepartureTime</code> and
@@ -601,9 +608,10 @@ export class Location extends LocationClient {
601608
* </li>
602609
* <li>
603610
* <p>
604-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
605-
* mode used to calculate the routes. This also lets you specify additional route
606-
* preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
611+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
612+
* mode</a> using TravelMode sets the transportation mode used to calculate
613+
* the routes. This also lets you specify additional route preferences in
614+
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
607615
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
608616
* </li>
609617
* </ul>
@@ -704,15 +712,16 @@ export class Location extends LocationClient {
704712

705713
/**
706714
* <p>Creates a place index resource in your AWS account. Use a place index resource to
707-
* geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,
708-
* and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and
709-
* enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
710-
* <note>
715+
* geocode addresses and other text queries by using the
716+
* <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by
717+
* using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions
718+
* by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
719+
* <note>
711720
* <p>If your application is tracking or routing assets you use in your business, such
712-
* as delivery vehicles or employees, you may only use HERE as your geolocation
713-
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
714-
* service terms</a> for more details.</p>
715-
* </note>
721+
* as delivery vehicles or employees, you may only use HERE as your geolocation
722+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
723+
* service terms</a> for more details.</p>
724+
* </note>
716725
*/
717726
public createPlaceIndex(
718727
args: CreatePlaceIndexCommandInput,
@@ -752,7 +761,7 @@ export class Location extends LocationClient {
752761
* <p>If your application is tracking or routing assets you use in your business, such
753762
* as delivery vehicles or employees, you may only use HERE as your geolocation
754763
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
755-
* service terms</a> for more details.</p>
764+
* service terms</a> for more details.</p>
756765
* </note>
757766
*/
758767
public createRouteCalculator(
@@ -885,9 +894,9 @@ export class Location extends LocationClient {
885894

886895
/**
887896
* <p>Deletes a place index resource from your AWS account.</p>
888-
* <note>
897+
* <note>
889898
* <p>This operation deletes the resource permanently.</p>
890-
* </note>
899+
* </note>
891900
*/
892901
public deletePlaceIndex(
893902
args: DeletePlaceIndexCommandInput,
@@ -922,7 +931,7 @@ export class Location extends LocationClient {
922931
* <p>Deletes a route calculator resource from your AWS account.</p>
923932
* <note>
924933
* <p>This operation deletes the resource permanently.</p>
925-
* </note>
934+
* </note>
926935
*/
927936
public deleteRouteCalculator(
928937
args: DeleteRouteCalculatorCommandInput,
@@ -1713,8 +1722,8 @@ export class Location extends LocationClient {
17131722
}
17141723

17151724
/**
1716-
* <p>Reverse geocodes a given coordinate and returns a legible address. Allows you to search
1717-
* for Places or points of interest near a given position.</p>
1725+
* <p>Reverse geocodes a given coordinate and returns a legible address. Allows you to
1726+
* search for Places or points of interest near a given position.</p>
17181727
*/
17191728
public searchPlaceIndexForPosition(
17201729
args: SearchPlaceIndexForPositionCommandInput,
@@ -1747,15 +1756,17 @@ export class Location extends LocationClient {
17471756

17481757
/**
17491758
* <p>Generates suggestions for addresses and points of interest based on partial or
1750-
* misspelled free-form text. This operation is also known as autocomplete, autosuggest,
1751-
* or fuzzy matching.</p>
1752-
* <p>Optional parameters let you narrow your search results by bounding box or
1753-
* country, or bias your search toward a specific position on the globe.</p>
1754-
* <note>
1755-
* <p>You can search for suggested place names near a specified position by using <code>BiasPosition</code>, or
1756-
* filter results within a bounding box by using <code>FilterBBox</code>. These parameters are mutually exclusive;
1757-
* using both <code>BiasPosition</code> and <code>FilterBBox</code> in the same command returns an error.</p>
1758-
* </note>
1759+
* misspelled free-form text. This operation is also known as autocomplete, autosuggest, or
1760+
* fuzzy matching.</p>
1761+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
1762+
* bias your search toward a specific position on the globe.</p>
1763+
* <note>
1764+
* <p>You can search for suggested place names near a specified position by using
1765+
* <code>BiasPosition</code>, or filter results within a bounding box by using
1766+
* <code>FilterBBox</code>. These parameters are mutually exclusive; using both
1767+
* <code>BiasPosition</code> and <code>FilterBBox</code> in the same command
1768+
* returns an error.</p>
1769+
* </note>
17591770
*/
17601771
public searchPlaceIndexForSuggestions(
17611772
args: SearchPlaceIndexForSuggestionsCommandInput,
@@ -1788,15 +1799,15 @@ export class Location extends LocationClient {
17881799

17891800
/**
17901801
* <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
1791-
* search for Places or points of interest. </p>
1792-
* <p>Optional parameters let you narrow your search results by bounding box or
1793-
* country, or bias your search toward a specific position on the globe.</p>
1794-
* <note>
1795-
* <p>You can search for places near a given position using <code>BiasPosition</code>, or
1796-
* filter results within a bounding box using <code>FilterBBox</code>. Providing both
1797-
* parameters simultaneously returns an error.</p>
1798-
* </note>
1799-
* <p>Search results are returned in order of highest to lowest relevance.</p>
1802+
* search for Places or points of interest. </p>
1803+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
1804+
* bias your search toward a specific position on the globe.</p>
1805+
* <note>
1806+
* <p>You can search for places near a given position using <code>BiasPosition</code>,
1807+
* or filter results within a bounding box using <code>FilterBBox</code>. Providing
1808+
* both parameters simultaneously returns an error.</p>
1809+
* </note>
1810+
* <p>Search results are returned in order of highest to lowest relevance.</p>
18001811
*/
18011812
public searchPlaceIndexForText(
18021813
args: SearchPlaceIndexForTextCommandInput,

‎clients/client-location/src/commands/BatchEvaluateGeofencesCommand.ts

+4
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ export interface BatchEvaluateGeofencesCommandOutput extends BatchEvaluateGeofen
4848
* <p>Geofence evaluation uses the given device position. It does not account for the
4949
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
5050
* </note>
51+
* <note>
52+
* <p>The <code>DeviceID</code> is used as a string to represent the device. You do not
53+
* need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p>
54+
* </note>
5155
* @example
5256
* Use a bare-bones client and the command you need to make an API call.
5357
* ```javascript

‎clients/client-location/src/commands/CalculateRouteCommand.ts

+7-5
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
3434
* <ul>
3535
* <li>
3636
* <p>
37-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code>
38-
* or <code>DepartNow</code>. This calculates a route based on predictive traffic
37+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
38+
* departure time</a> using either <code>DepartureTime</code> or
39+
* <code>DepartNow</code>. This calculates a route based on predictive traffic
3940
* data at the given time. </p>
4041
* <note>
4142
* <p>You can't specify both <code>DepartureTime</code> and
@@ -45,9 +46,10 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
4546
* </li>
4647
* <li>
4748
* <p>
48-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
49-
* mode used to calculate the routes. This also lets you specify additional route
50-
* preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
49+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
50+
* mode</a> using TravelMode sets the transportation mode used to calculate
51+
* the routes. This also lets you specify additional route preferences in
52+
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
5153
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
5254
* </li>
5355
* </ul>

0 commit comments

Comments
 (0)