@aws-sdk/client-location 3.35.0 → 3.38.0

package/dist-types/index.d.ts

@@ -1,63 +1,5 @@
-export * from "./LocationClient";
 export * from "./Location";
-export * from "./commands/AssociateTrackerConsumerCommand";
-export * from "./commands/BatchDeleteDevicePositionHistoryCommand";
-export * from "./commands/BatchDeleteGeofenceCommand";
-export * from "./commands/BatchEvaluateGeofencesCommand";
-export * from "./commands/BatchGetDevicePositionCommand";
-export * from "./commands/BatchPutGeofenceCommand";
-export * from "./commands/BatchUpdateDevicePositionCommand";
-export * from "./commands/CalculateRouteCommand";
-export * from "./commands/CreateGeofenceCollectionCommand";
-export * from "./commands/CreateMapCommand";
-export * from "./commands/CreatePlaceIndexCommand";
-export * from "./commands/CreateRouteCalculatorCommand";
-export * from "./commands/CreateTrackerCommand";
-export * from "./commands/DeleteGeofenceCollectionCommand";
-export * from "./commands/DeleteMapCommand";
-export * from "./commands/DeletePlaceIndexCommand";
-export * from "./commands/DeleteRouteCalculatorCommand";
-export * from "./commands/DeleteTrackerCommand";
-export * from "./commands/DescribeGeofenceCollectionCommand";
-export * from "./commands/DescribeMapCommand";
-export * from "./commands/DescribePlaceIndexCommand";
-export * from "./commands/DescribeRouteCalculatorCommand";
-export * from "./commands/DescribeTrackerCommand";
-export * from "./commands/DisassociateTrackerConsumerCommand";
-export * from "./commands/GetDevicePositionCommand";
-export * from "./commands/GetDevicePositionHistoryCommand";
-export * from "./pagination/GetDevicePositionHistoryPaginator";
-export * from "./commands/GetGeofenceCommand";
-export * from "./commands/GetMapGlyphsCommand";
-export * from "./commands/GetMapSpritesCommand";
-export * from "./commands/GetMapStyleDescriptorCommand";
-export * from "./commands/GetMapTileCommand";
-export * from "./commands/ListDevicePositionsCommand";
-export * from "./pagination/ListDevicePositionsPaginator";
-export * from "./commands/ListGeofenceCollectionsCommand";
-export * from "./pagination/ListGeofenceCollectionsPaginator";
-export * from "./commands/ListGeofencesCommand";
-export * from "./pagination/ListGeofencesPaginator";
-export * from "./commands/ListMapsCommand";
-export * from "./pagination/ListMapsPaginator";
-export * from "./commands/ListPlaceIndexesCommand";
-export * from "./pagination/ListPlaceIndexesPaginator";
-export * from "./commands/ListRouteCalculatorsCommand";
-export * from "./pagination/ListRouteCalculatorsPaginator";
-export * from "./commands/ListTagsForResourceCommand";
-export * from "./commands/ListTrackerConsumersCommand";
-export * from "./pagination/ListTrackerConsumersPaginator";
-export * from "./commands/ListTrackersCommand";
-export * from "./pagination/ListTrackersPaginator";
-export * from "./commands/PutGeofenceCommand";
-export * from "./commands/SearchPlaceIndexForPositionCommand";
-export * from "./commands/SearchPlaceIndexForTextCommand";
-export * from "./commands/TagResourceCommand";
-export * from "./commands/UntagResourceCommand";
-export * from "./commands/UpdateGeofenceCollectionCommand";
-export * from "./commands/UpdateMapCommand";
-export * from "./commands/UpdatePlaceIndexCommand";
-export * from "./commands/UpdateRouteCalculatorCommand";
-export * from "./commands/UpdateTrackerCommand";
-export * from "./pagination/Interfaces";
-export * from "./models/index";
+export * from "./LocationClient";
+export * from "./commands";
+export * from "./models";
+export * from "./pagination";

package/dist-types/models/models_0.d.ts

@@ -802,7 +802,8 @@ export interface CalculateRouteRequest {
      *          </ul>
      *         <note>
      *             <p>If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">moves the
-     *                 position to the nearest road</a>.</p>
+     *                 position to the nearest road</a>. If Esri is the provider for your route calculator,
+     *                 specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error.</p>
      *         </note>
      *         <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
      *          </p>
@@ -839,6 +840,8 @@ export interface CalculateRouteRequest {
      *             <p>If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">moves the position to the nearest road</a>. </p>
      *             <p>Specifying more than 23 waypoints returns a <code>400 ValidationException</code>
      *                 error.</p>
+     *             <p>If Esri is the provider for your route calculator, specifying a
+     *                 route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error.</p>
      *         </note>
      *         <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
      *          </p>
@@ -1094,7 +1097,7 @@ export interface CalculateRouteSummary {
      *                     upper northeast corner. </p>
      *             </li>
      *             <li>
-     *                 <p>The fourth <code>bbox</code> position is the Y coordinate, or longitude of the
+     *                 <p>The fourth <code>bbox</code> position is the Y coordinate, or latitude of the
      *                     upper northeast corner. </p>
      *             </li>
      *          </ul>
@@ -1122,9 +1125,9 @@ export interface CalculateRouteSummary {
      * <p>The total distance covered by the route. The sum of the distance travelled between
      *             every stop on the route.</p>
      *         <note>
-     *             <p>The route <code>distance</code> can't be greater than 250 km. If the route exceeds
-     *                 250 km, the response returns a <code>400 RoutesValidationException</code>
-     *                 error.</p>
+     *             <p>If Esri is the data source for the route calculator, the route distance can’t
+     *                 be greater than 400 km. If the route exceeds 400 km, the response is a
+     *                 <code>400 RoutesValidationException</code> error.</p>
      *         </note>
      */
     Distance: number | undefined;
@@ -1317,11 +1320,8 @@ export declare namespace CreateGeofenceCollectionResponse {
  */
 export interface MapConfiguration {
     /**
-     * <p>Specifies the map style selected from an available data provider. For additional
-     *             information on each map style and to preview each map style, see <a href="location/latest/developerguide/esri.html#esri-map-styles">Esri map
-     *                 styles</a> and <a href="location/latest/developerguide/HERE.html#HERE-map-styles">HERE map
-     *                 styles</a>.</p>
-     *         <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a> styles: </p>
+     * <p>Specifies the map style selected from an available data provider.</p>
+     *         <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri map styles</a>:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -1362,7 +1362,7 @@ export interface MapConfiguration {
      *             </li>
      *          </ul>
      *         <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
-     *                 Technologies</a> styles: </p>
+     *                 Technologies map styles</a>:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -1408,8 +1408,7 @@ export interface CreateMapRequest {
     Configuration: MapConfiguration | undefined;
     /**
      * <p>Specifies the pricing plan for your map resource.</p>
-     *         <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *                 page</a>.</p>
+     *         <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -1559,7 +1558,7 @@ export interface CreatePlaceIndexRequest {
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a>'s
+     *                   <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a>'
      *                coverage in your region of interest, see <a href="https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html">HERE details on goecoding coverage</a>.</p>
      *                <important>
      *                   <p>Place index resources using HERE Technologies as a data provider can't <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see the
@@ -1574,8 +1573,7 @@ export interface CreatePlaceIndexRequest {
     DataSource: string | undefined;
     /**
      * <p>Specifies the pricing plan for your place index resource.</p>
-     *          <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *          page</a>.</p>
+     *          <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -1672,7 +1670,8 @@ export interface CreateRouteCalculatorRequest {
      * <p>Specifies the data provider of traffic and road network data.</p>
      *         <note>
      *             <p>This field is case-sensitive. Enter the valid values as shown. For example,
-     *                 entering <code>HERE</code> returns an error.</p>
+     *                 entering <code>HERE</code> returns an error. Route calculators that use Esri as a data source
+     *                only calculate routes that are shorter than 400 km.</p>
      *         </note>
      *         <p>Valid values include:</p>
      *         <ul>
@@ -1683,7 +1682,7 @@ export interface CreateRouteCalculatorRequest {
      *             <li>
      *                 <p>
      *                   <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
-     *                         Technologies</a>'s coverage in your region of interest, see <a href="https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html">HERE car routing coverage</a> and <a href="https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html">HERE truck routing coverage</a>.</p>
+     *                         Technologies</a>' coverage in your region of interest, see <a href="https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html">HERE car routing coverage</a> and <a href="https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html">HERE truck routing coverage</a>.</p>
      *             </li>
      *          </ul>
      *         <p>For additional information , see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Data
@@ -1780,6 +1779,7 @@ export declare namespace CreateRouteCalculatorResponse {
      */
     const filterSensitiveLog: (obj: CreateRouteCalculatorResponse) => any;
 }
+export declare type PositionFiltering = "DistanceBased" | "TimeBased";
 export interface CreateTrackerRequest {
     /**
      * <p>The name for the tracker resource.</p>
@@ -1799,8 +1799,7 @@ export interface CreateTrackerRequest {
     TrackerName: string | undefined;
     /**
      * <p>Specifies the pricing plan for the tracker resource.</p>
-     *          <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *            page</a>.</p>
+     *          <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -1821,7 +1820,7 @@ export interface CreateTrackerRequest {
      * 	        <note>
      * 	           <p>Amazon Location Service only uses <code>PricingPlanDataSource</code> to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.</p>
      * 	        </note>
-     *         <p>Valid Values: <code>Esri</code> | <code>Here</code>
+     *         <p>Valid values: <code>Esri</code> | <code>Here</code>
      *          </p>
      */
     PricingPlanDataSource?: string;
@@ -1857,6 +1856,29 @@ export interface CreateTrackerRequest {
     Tags?: {
         [key: string]: string;
     };
+    /**
+     * <p>Specifies the position filtering for the tracker resource.</p>
+     *         <p>Valid values:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                     <code>TimeBased</code> - Location updates are evaluated against linked geofence collections,
+     *                     but not every location update is stored. If your update frequency is more often than 30 seconds,
+     *                     only one update per 30 seconds is stored for each unique device ID.
+     *                 </p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                     <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
+     *                     ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
+     *                     This helps control costs by reducing the number of geofence evaluations and device positions to retrieve.
+     *                     Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
+     *                 </p>
+     *             </li>
+     *          </ul>
+     *         <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
+     */
+    PositionFiltering?: PositionFiltering | string;
 }
 export declare namespace CreateTrackerRequest {
     /**
@@ -2097,8 +2119,7 @@ export interface DescribeMapResponse {
     /**
      * <p>The pricing plan selected for the specified map resource.</p>
      *
-     *         <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *                 page</a>.</p>
+     *         <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -2167,8 +2188,7 @@ export interface DescribePlaceIndexResponse {
     IndexArn: string | undefined;
     /**
      * <p>The pricing plan selected for the specified place index resource.</p>
-     *          <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *             page</a>.</p>
+     *          <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -2199,8 +2219,7 @@ export interface DescribePlaceIndexResponse {
      *                </p>
      *             </li>
      *          </ul>
-     *          <p>For additional details on data providers, see the <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers
-     *          page</a>.</p>
+     *          <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
      */
     DataSource: string | undefined;
     /**
@@ -2346,8 +2365,7 @@ export interface DescribeTrackerResponse {
     Description: string | undefined;
     /**
      * <p>The pricing plan selected for the specified tracker resource.</p>
-     *         <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *                 page</a>.</p>
+     *         <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -2374,6 +2392,10 @@ export interface DescribeTrackerResponse {
      * <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">AWS KMS customer managed key</a> assigned to the Amazon Location resource.</p>
      */
     KmsKeyId?: string;
+    /**
+     * <p>The position filtering method of the tracker resource.</p>
+     */
+    PositionFiltering?: PositionFiltering | string;
 }
 export declare namespace DescribeTrackerResponse {
     /**
@@ -2999,7 +3021,7 @@ export interface GetMapGlyphsRequest {
     /**
      * <p>A comma-separated list of fonts to load glyphs from in order of preference. For
      *             example, <code>Noto Sans Regular, Arial Unicode</code>.</p>
-     *         <p>Valid fonts for <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a> styles: </p>
+     *         <p>Valid fonts stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a> styles: </p>
      *         <ul>
      *             <li>
      *                 <p>VectorEsriDarkGrayCanvas – <code>Ubuntu Medium Italic</code> | <code>Ubuntu
@@ -3029,11 +3051,10 @@ export interface GetMapGlyphsRequest {
      *                </p>
      *             </li>
      *          </ul>
-     *         <p>Valid fonts for <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a> styles: </p>
+     *         <p>Valid font stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a> styles: </p>
      *         <ul>
      *             <li>
-     *                 <p>
-     *                   <code>VectorHereBerlin</code> – <code>Fira GO Regular</code> | <code>Fira GO
+     *                 <p>VectorHereBerlin – <code>Fira GO Regular</code> | <code>Fira GO
      *                         Bold</code>
      *                </p>
      *             </li>
@@ -3302,8 +3323,7 @@ export interface ListMapsResponseEntry {
     DataSource: string | undefined;
     /**
      * <p>The pricing plan for the specified map resource.</p>
-     *         <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *             page</a>.</p>
+     *         <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -3386,13 +3406,12 @@ export interface ListPlaceIndexesResponseEntry {
      *                </p>
      *             </li>
      *          </ul>
-     *          <p>For additional details on data providers, see the <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers page</a>.</p>
+     *          <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
      */
     DataSource: string | undefined;
     /**
      * <p>The pricing plan for the specified place index resource.</p>
-     *          <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *          page</a>.</p>
+     *          <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -3608,8 +3627,7 @@ export interface ListTrackersResponseEntry {
     Description: string | undefined;
     /**
      * <p>The pricing plan for the specified tracker resource.</p>
-     *         <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
-     *             page</a>.</p>
+     *         <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
      */
     PricingPlan: PricingPlan | string | undefined;
     /**
@@ -3856,7 +3874,7 @@ export interface SearchPlaceIndexForPositionSummary {
      *                <p>HERE</p>
      *             </li>
      *          </ul>
-     *          <p>For additional details on data providers, see the <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers page</a>.</p>
+     *          <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
      */
     DataSource: string | undefined;
 }
@@ -4021,7 +4039,7 @@ export interface SearchPlaceIndexForTextSummary {
      *                <p>HERE</p>
      *             </li>
      *          </ul>
-     *          <p>For additional details on data providers, see the <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers page</a>.</p>
+     *          <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
      */
     DataSource: string | undefined;
 }
@@ -4185,6 +4203,28 @@ export interface UpdateTrackerRequest {
      * <p>Updates the description for the tracker resource.</p>
      */
     Description?: string;
+    /**
+     * <p>Updates the position filtering for the tracker resource.</p>
+     *         <p>Valid values:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                     <code>TimeBased</code> - Location updates are evaluated against linked geofence collections,
+     *                     but not every location update is stored. If your update frequency is more often than 30 seconds,
+     *                     only one update per 30 seconds is stored for each unique device ID.
+     *                 </p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                     <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
+     *                     ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
+     *                     This helps control costs by reducing the number of geofence evaluations and device positions to retrieve.
+     *                     Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
+     *                 </p>
+     *             </li>
+     *          </ul>
+     */
+    PositionFiltering?: PositionFiltering | string;
 }
 export declare namespace UpdateTrackerRequest {
     /**

package/dist-types/pagination/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./GetDevicePositionHistoryPaginator";
+export * from "./Interfaces";
+export * from "./ListDevicePositionsPaginator";
+export * from "./ListGeofenceCollectionsPaginator";
+export * from "./ListGeofencesPaginator";
+export * from "./ListMapsPaginator";
+export * from "./ListPlaceIndexesPaginator";
+export * from "./ListRouteCalculatorsPaginator";
+export * from "./ListTrackerConsumersPaginator";
+export * from "./ListTrackersPaginator";