@aws-sdk/client-location 3.46.0 → 3.48.0

package/dist-types/LocationClient.d.ts

@@ -4,7 +4,7 @@ import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry
 import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
 import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
 import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
-import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
+import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
 import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
 import { AssociateTrackerConsumerCommandInput, AssociateTrackerConsumerCommandOutput } from "./commands/AssociateTrackerConsumerCommand";
 import { BatchDeleteDevicePositionHistoryCommandInput, BatchDeleteDevicePositionHistoryCommandOutput } from "./commands/BatchDeleteDevicePositionHistoryCommand";
@@ -14,6 +14,7 @@ import { BatchGetDevicePositionCommandInput, BatchGetDevicePositionCommandOutput
 import { BatchPutGeofenceCommandInput, BatchPutGeofenceCommandOutput } from "./commands/BatchPutGeofenceCommand";
 import { BatchUpdateDevicePositionCommandInput, BatchUpdateDevicePositionCommandOutput } from "./commands/BatchUpdateDevicePositionCommand";
 import { CalculateRouteCommandInput, CalculateRouteCommandOutput } from "./commands/CalculateRouteCommand";
+import { CalculateRouteMatrixCommandInput, CalculateRouteMatrixCommandOutput } from "./commands/CalculateRouteMatrixCommand";
 import { CreateGeofenceCollectionCommandInput, CreateGeofenceCollectionCommandOutput } from "./commands/CreateGeofenceCollectionCommand";
 import { CreateMapCommandInput, CreateMapCommandOutput } from "./commands/CreateMapCommand";
 import { CreatePlaceIndexCommandInput, CreatePlaceIndexCommandOutput } from "./commands/CreatePlaceIndexCommand";
@@ -57,8 +58,8 @@ import { UpdateMapCommandInput, UpdateMapCommandOutput } from "./commands/Update
 import { UpdatePlaceIndexCommandInput, UpdatePlaceIndexCommandOutput } from "./commands/UpdatePlaceIndexCommand";
 import { UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput } from "./commands/UpdateRouteCalculatorCommand";
 import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./commands/UpdateTrackerCommand";
-export declare type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CreateGeofenceCollectionCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForSuggestionsCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput;
-export declare type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CreateGeofenceCollectionCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForSuggestionsCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput;
+export declare type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CalculateRouteMatrixCommandInput | CreateGeofenceCollectionCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForSuggestionsCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput;
+export declare type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CalculateRouteMatrixCommandOutput | CreateGeofenceCollectionCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForSuggestionsCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput;
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -159,6 +160,10 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      * @internal
      */
     defaultUserAgentProvider?: Provider<__UserAgent>;
+    /**
+     * The {@link DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     */
+    defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
 }
 declare type LocationClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
 /**

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

@@ -9,7 +9,7 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
 /**
  * <p>
  *             <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters:
- *                 <code>DeparturePostiton</code> and <code>DestinationPosition</code>. Requires that
+ *                 <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that
  *             you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
  *                 route calculator resource</a>.</p>
  *         <p>By default, a request that doesn't specify a departure time uses the best time of day
@@ -18,25 +18,23 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
  *         <ul>
  *             <li>
  *                 <p>
- *                   <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#departure-time">Specifying a departure time</a> using either <code>DepartureTime</code> or
- *                         <code>DepartureNow</code>. This calculates a route based on predictive
- *                     traffic data at the given time. </p>
+ *                   <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code>
+ *                     or <code>DepartNow</code>. This calculates a route based on predictive traffic
+ *                     data at the given time. </p>
  *                 <note>
  *                     <p>You can't specify both <code>DepartureTime</code> and
- *                             <code>DepartureNow</code> in a single request. Specifying both
- *                         parameters returns a validation error.</p>
+ *                             <code>DepartNow</code> in a single request. Specifying both parameters
+ *                         returns a validation error.</p>
  *                 </note>
  *             </li>
  *             <li>
  *                 <p>
- *                   <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#travel-mode">Specifying a travel mode</a> using TravelMode. This lets you specify an
- *                     additional route preference such as <code>CarModeOptions</code> if traveling by
- *                         <code>Car</code>, or <code>TruckModeOptions</code> if traveling by
- *                         <code>Truck</code>.</p>
+ *                   <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
+ *                     mode used to calculate the routes. This also lets you specify additional route
+ *                     preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
+ *                         <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
  *             </li>
  *          </ul>
- *         <p>
- *             </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -0,0 +1,74 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
+import { CalculateRouteMatrixRequest, CalculateRouteMatrixResponse } from "../models/models_0";
+export interface CalculateRouteMatrixCommandInput extends CalculateRouteMatrixRequest {
+}
+export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixResponse, __MetadataBearer {
+}
+/**
+ * <p>
+ *             <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a
+ *             route matrix</a> given the following required parameters:
+ *             <code>DeparturePositions</code> and <code>DestinationPositions</code>.
+ *             <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
+ *             travel distance from each departure position to each destination position in the
+ *             request. For example, given departure positions A and B, and destination positions
+ *             X and Y, <code>CalculateRouteMatrix</code> will return time and distance for routes
+ *             from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned
+ *             (and routes calculated) will be the number of <code>DeparturePositions</code>
+ *             times the number of <code>DestinationPositions</code>.</p>
+ *         <note>
+ *             <p>Your account is charged for each route calculated, not the number of requests.</p>
+ *         </note>
+ *         <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
+ *             route calculator resource</a>.</p>
+ *         <p>By default, a request that doesn't specify a departure time uses the best time of day
+ *             to travel with the best traffic conditions when calculating routes.</p>
+ *         <p>Additional options include:</p>
+ *         <ul>
+ *             <li>
+ *                 <p>
+ *                   <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">
+ *                         Specifying a departure time</a> using either <code>DepartureTime</code>
+ *                     or <code>DepartNow</code>. This calculates routes based on predictive traffic
+ *                     data at the given time. </p>
+ *                 <note>
+ *                     <p>You can't specify both <code>DepartureTime</code> and
+ *                             <code>DepartNow</code> in a single request. Specifying both parameters
+ *                         returns a validation error.</p>
+ *                 </note>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
+ *                     mode used to calculate the routes. This also lets you specify additional route
+ *                     preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
+ *                         <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { LocationClient, CalculateRouteMatrixCommand } from "@aws-sdk/client-location"; // ES Modules import
+ * // const { LocationClient, CalculateRouteMatrixCommand } = require("@aws-sdk/client-location"); // CommonJS import
+ * const client = new LocationClient(config);
+ * const command = new CalculateRouteMatrixCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CalculateRouteMatrixCommandInput} for command's `input` shape.
+ * @see {@link CalculateRouteMatrixCommandOutput} for command's `response` shape.
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
+ *
+ */
+export declare class CalculateRouteMatrixCommand extends $Command<CalculateRouteMatrixCommandInput, CalculateRouteMatrixCommandOutput, LocationClientResolvedConfig> {
+    readonly input: CalculateRouteMatrixCommandInput;
+    constructor(input: CalculateRouteMatrixCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CalculateRouteMatrixCommandInput, CalculateRouteMatrixCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -9,6 +9,12 @@ export interface CreateMapCommandOutput extends CreateMapResponse, __MetadataBea
 /**
  * <p>Creates a map resource in your AWS account, which provides map tiles of different
  *             styles sourced from global location data providers.</p>
+ *         <note>
+ *             <p>If your application is tracking or routing assets you use in your business, such
+ *                 as delivery vehicles or employees, you may only use HERE as your geolocation
+ *                 provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
+ *                     service terms</a> for more details.</p>
+ *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -11,6 +11,12 @@ export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse,
  *             geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,
  *             and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and
  *             enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
+ *          <note>
+ *             <p>If your application is tracking or routing assets you use in your business, such
+ *             as delivery vehicles or employees, you may only use HERE as your geolocation
+ *             provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
+ *                service terms</a> for more details.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -11,6 +11,12 @@ export interface CreateRouteCalculatorCommandOutput extends CreateRouteCalculato
  *         <p>You can send requests to a route calculator resource to estimate travel time,
  *             distance, and get directions. A route calculator sources traffic and road network data
  *             from your chosen data provider.</p>
+ *         <note>
+ *             <p>If your application is tracking or routing assets you use in your business, such
+ *                 as delivery vehicles or employees, you may only use HERE as your geolocation
+ *                 provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
+ *                 service terms</a> for more details.</p>
+ *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -6,6 +6,7 @@ export * from "./BatchGetDevicePositionCommand";
 export * from "./BatchPutGeofenceCommand";
 export * from "./BatchUpdateDevicePositionCommand";
 export * from "./CalculateRouteCommand";
+export * from "./CalculateRouteMatrixCommand";
 export * from "./CreateGeofenceCollectionCommand";
 export * from "./CreateMapCommand";
 export * from "./CreatePlaceIndexCommand";