@aws-sdk/client-location 3.47.2 → 3.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/dist-cjs/Location.js +15 -0
- package/dist-cjs/commands/CalculateRouteMatrixCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +37 -3
- package/dist-cjs/protocols/Aws_restJson1.js +217 -3
- package/dist-es/Location.js +15 -0
- package/dist-es/commands/CalculateRouteMatrixCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +20 -0
- package/dist-es/protocols/Aws_restJson1.js +226 -0
- package/dist-types/Location.d.ts +74 -12
- package/dist-types/LocationClient.d.ts +3 -2
- package/dist-types/commands/CalculateRouteCommand.d.ts +10 -12
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +74 -0
- package/dist-types/commands/CreateMapCommand.d.ts +6 -0
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +6 -0
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +6 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +398 -127
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/Location.d.ts +5 -0
- package/dist-types/ts3.4/LocationClient.d.ts +3 -2
- package/dist-types/ts3.4/commands/CalculateRouteMatrixCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +89 -10
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +3 -0
- package/package.json +3 -3
|
@@ -380,6 +380,63 @@ export var serializeAws_restJson1CalculateRouteCommand = function (input, contex
|
|
|
380
380
|
}
|
|
381
381
|
});
|
|
382
382
|
}); };
|
|
383
|
+
export var serializeAws_restJson1CalculateRouteMatrixCommand = function (input, context) { return __awaiter(void 0, void 0, void 0, function () {
|
|
384
|
+
var _a, hostname, _b, protocol, port, basePath, headers, resolvedPath, labelValue, body, resolvedHostname;
|
|
385
|
+
return __generator(this, function (_c) {
|
|
386
|
+
switch (_c.label) {
|
|
387
|
+
case 0: return [4, context.endpoint()];
|
|
388
|
+
case 1:
|
|
389
|
+
_a = _c.sent(), hostname = _a.hostname, _b = _a.protocol, protocol = _b === void 0 ? "https" : _b, port = _a.port, basePath = _a.path;
|
|
390
|
+
headers = {
|
|
391
|
+
"content-type": "application/json",
|
|
392
|
+
};
|
|
393
|
+
resolvedPath = "" + ((basePath === null || basePath === void 0 ? void 0 : basePath.endsWith("/")) ? basePath.slice(0, -1) : basePath || "") +
|
|
394
|
+
"/routes/v0/calculators/{CalculatorName}/calculate/route-matrix";
|
|
395
|
+
if (input.CalculatorName !== undefined) {
|
|
396
|
+
labelValue = input.CalculatorName;
|
|
397
|
+
if (labelValue.length <= 0) {
|
|
398
|
+
throw new Error("Empty value provided for input HTTP label: CalculatorName.");
|
|
399
|
+
}
|
|
400
|
+
resolvedPath = resolvedPath.replace("{CalculatorName}", __extendedEncodeURIComponent(labelValue));
|
|
401
|
+
}
|
|
402
|
+
else {
|
|
403
|
+
throw new Error("No value provided for input HTTP label: CalculatorName.");
|
|
404
|
+
}
|
|
405
|
+
body = JSON.stringify(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.CarModeOptions !== undefined &&
|
|
406
|
+
input.CarModeOptions !== null && {
|
|
407
|
+
CarModeOptions: serializeAws_restJson1CalculateRouteCarModeOptions(input.CarModeOptions, context),
|
|
408
|
+
})), (input.DepartNow !== undefined && input.DepartNow !== null && { DepartNow: input.DepartNow })), (input.DeparturePositions !== undefined &&
|
|
409
|
+
input.DeparturePositions !== null && {
|
|
410
|
+
DeparturePositions: serializeAws_restJson1PositionList(input.DeparturePositions, context),
|
|
411
|
+
})), (input.DepartureTime !== undefined &&
|
|
412
|
+
input.DepartureTime !== null && { DepartureTime: input.DepartureTime.toISOString().split(".")[0] + "Z" })), (input.DestinationPositions !== undefined &&
|
|
413
|
+
input.DestinationPositions !== null && {
|
|
414
|
+
DestinationPositions: serializeAws_restJson1PositionList(input.DestinationPositions, context),
|
|
415
|
+
})), (input.DistanceUnit !== undefined && input.DistanceUnit !== null && { DistanceUnit: input.DistanceUnit })), (input.TravelMode !== undefined && input.TravelMode !== null && { TravelMode: input.TravelMode })), (input.TruckModeOptions !== undefined &&
|
|
416
|
+
input.TruckModeOptions !== null && {
|
|
417
|
+
TruckModeOptions: serializeAws_restJson1CalculateRouteTruckModeOptions(input.TruckModeOptions, context),
|
|
418
|
+
})));
|
|
419
|
+
return [4, context.endpoint()];
|
|
420
|
+
case 2:
|
|
421
|
+
resolvedHostname = (_c.sent()).hostname;
|
|
422
|
+
if (context.disableHostPrefix !== true) {
|
|
423
|
+
resolvedHostname = "routes." + resolvedHostname;
|
|
424
|
+
if (!__isValidHostname(resolvedHostname)) {
|
|
425
|
+
throw new Error("ValidationError: prefixed hostname must be hostname compatible.");
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
return [2, new __HttpRequest({
|
|
429
|
+
protocol: protocol,
|
|
430
|
+
hostname: resolvedHostname,
|
|
431
|
+
port: port,
|
|
432
|
+
method: "POST",
|
|
433
|
+
headers: headers,
|
|
434
|
+
path: resolvedPath,
|
|
435
|
+
body: body,
|
|
436
|
+
})];
|
|
437
|
+
}
|
|
438
|
+
});
|
|
439
|
+
}); };
|
|
383
440
|
export var serializeAws_restJson1CreateGeofenceCollectionCommand = function (input, context) { return __awaiter(void 0, void 0, void 0, function () {
|
|
384
441
|
var _a, hostname, _b, protocol, port, basePath, headers, resolvedPath, body, resolvedHostname;
|
|
385
442
|
return __generator(this, function (_c) {
|
|
@@ -3009,6 +3066,112 @@ var deserializeAws_restJson1CalculateRouteCommandError = function (output, conte
|
|
|
3009
3066
|
}
|
|
3010
3067
|
});
|
|
3011
3068
|
}); };
|
|
3069
|
+
export var deserializeAws_restJson1CalculateRouteMatrixCommand = function (output, context) { return __awaiter(void 0, void 0, void 0, function () {
|
|
3070
|
+
var contents, data, _a, _b;
|
|
3071
|
+
return __generator(this, function (_c) {
|
|
3072
|
+
switch (_c.label) {
|
|
3073
|
+
case 0:
|
|
3074
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
3075
|
+
return [2, deserializeAws_restJson1CalculateRouteMatrixCommandError(output, context)];
|
|
3076
|
+
}
|
|
3077
|
+
contents = {
|
|
3078
|
+
$metadata: deserializeMetadata(output),
|
|
3079
|
+
RouteMatrix: undefined,
|
|
3080
|
+
SnappedDeparturePositions: undefined,
|
|
3081
|
+
SnappedDestinationPositions: undefined,
|
|
3082
|
+
Summary: undefined,
|
|
3083
|
+
};
|
|
3084
|
+
_a = __expectNonNull;
|
|
3085
|
+
_b = __expectObject;
|
|
3086
|
+
return [4, parseBody(output.body, context)];
|
|
3087
|
+
case 1:
|
|
3088
|
+
data = _a.apply(void 0, [_b.apply(void 0, [_c.sent()]), "body"]);
|
|
3089
|
+
if (data.RouteMatrix !== undefined && data.RouteMatrix !== null) {
|
|
3090
|
+
contents.RouteMatrix = deserializeAws_restJson1RouteMatrix(data.RouteMatrix, context);
|
|
3091
|
+
}
|
|
3092
|
+
if (data.SnappedDeparturePositions !== undefined && data.SnappedDeparturePositions !== null) {
|
|
3093
|
+
contents.SnappedDeparturePositions = deserializeAws_restJson1PositionList(data.SnappedDeparturePositions, context);
|
|
3094
|
+
}
|
|
3095
|
+
if (data.SnappedDestinationPositions !== undefined && data.SnappedDestinationPositions !== null) {
|
|
3096
|
+
contents.SnappedDestinationPositions = deserializeAws_restJson1PositionList(data.SnappedDestinationPositions, context);
|
|
3097
|
+
}
|
|
3098
|
+
if (data.Summary !== undefined && data.Summary !== null) {
|
|
3099
|
+
contents.Summary = deserializeAws_restJson1CalculateRouteMatrixSummary(data.Summary, context);
|
|
3100
|
+
}
|
|
3101
|
+
return [2, Promise.resolve(contents)];
|
|
3102
|
+
}
|
|
3103
|
+
});
|
|
3104
|
+
}); };
|
|
3105
|
+
var deserializeAws_restJson1CalculateRouteMatrixCommandError = function (output, context) { return __awaiter(void 0, void 0, void 0, function () {
|
|
3106
|
+
var parsedOutput, _a, response, errorCode, _b, _c, _d, _e, _f, _g, parsedBody, message;
|
|
3107
|
+
var _h;
|
|
3108
|
+
return __generator(this, function (_j) {
|
|
3109
|
+
switch (_j.label) {
|
|
3110
|
+
case 0:
|
|
3111
|
+
_a = [__assign({}, output)];
|
|
3112
|
+
_h = {};
|
|
3113
|
+
return [4, parseBody(output.body, context)];
|
|
3114
|
+
case 1:
|
|
3115
|
+
parsedOutput = __assign.apply(void 0, _a.concat([(_h.body = _j.sent(), _h)]));
|
|
3116
|
+
errorCode = "UnknownError";
|
|
3117
|
+
errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
3118
|
+
_b = errorCode;
|
|
3119
|
+
switch (_b) {
|
|
3120
|
+
case "AccessDeniedException": return [3, 2];
|
|
3121
|
+
case "com.amazonaws.location#AccessDeniedException": return [3, 2];
|
|
3122
|
+
case "InternalServerException": return [3, 4];
|
|
3123
|
+
case "com.amazonaws.location#InternalServerException": return [3, 4];
|
|
3124
|
+
case "ResourceNotFoundException": return [3, 6];
|
|
3125
|
+
case "com.amazonaws.location#ResourceNotFoundException": return [3, 6];
|
|
3126
|
+
case "ThrottlingException": return [3, 8];
|
|
3127
|
+
case "com.amazonaws.location#ThrottlingException": return [3, 8];
|
|
3128
|
+
case "ValidationException": return [3, 10];
|
|
3129
|
+
case "com.amazonaws.location#ValidationException": return [3, 10];
|
|
3130
|
+
}
|
|
3131
|
+
return [3, 12];
|
|
3132
|
+
case 2:
|
|
3133
|
+
_c = [{}];
|
|
3134
|
+
return [4, deserializeAws_restJson1AccessDeniedExceptionResponse(parsedOutput, context)];
|
|
3135
|
+
case 3:
|
|
3136
|
+
response = __assign.apply(void 0, [__assign.apply(void 0, _c.concat([(_j.sent())])), { name: errorCode, $metadata: deserializeMetadata(output) }]);
|
|
3137
|
+
return [3, 13];
|
|
3138
|
+
case 4:
|
|
3139
|
+
_d = [{}];
|
|
3140
|
+
return [4, deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context)];
|
|
3141
|
+
case 5:
|
|
3142
|
+
response = __assign.apply(void 0, [__assign.apply(void 0, _d.concat([(_j.sent())])), { name: errorCode, $metadata: deserializeMetadata(output) }]);
|
|
3143
|
+
return [3, 13];
|
|
3144
|
+
case 6:
|
|
3145
|
+
_e = [{}];
|
|
3146
|
+
return [4, deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context)];
|
|
3147
|
+
case 7:
|
|
3148
|
+
response = __assign.apply(void 0, [__assign.apply(void 0, _e.concat([(_j.sent())])), { name: errorCode, $metadata: deserializeMetadata(output) }]);
|
|
3149
|
+
return [3, 13];
|
|
3150
|
+
case 8:
|
|
3151
|
+
_f = [{}];
|
|
3152
|
+
return [4, deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context)];
|
|
3153
|
+
case 9:
|
|
3154
|
+
response = __assign.apply(void 0, [__assign.apply(void 0, _f.concat([(_j.sent())])), { name: errorCode, $metadata: deserializeMetadata(output) }]);
|
|
3155
|
+
return [3, 13];
|
|
3156
|
+
case 10:
|
|
3157
|
+
_g = [{}];
|
|
3158
|
+
return [4, deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context)];
|
|
3159
|
+
case 11:
|
|
3160
|
+
response = __assign.apply(void 0, [__assign.apply(void 0, _g.concat([(_j.sent())])), { name: errorCode, $metadata: deserializeMetadata(output) }]);
|
|
3161
|
+
return [3, 13];
|
|
3162
|
+
case 12:
|
|
3163
|
+
parsedBody = parsedOutput.body;
|
|
3164
|
+
errorCode = parsedBody.code || parsedBody.Code || errorCode;
|
|
3165
|
+
response = __assign(__assign({}, parsedBody), { name: "" + errorCode, message: parsedBody.message || parsedBody.Message || errorCode, $fault: "client", $metadata: deserializeMetadata(output) });
|
|
3166
|
+
_j.label = 13;
|
|
3167
|
+
case 13:
|
|
3168
|
+
message = response.message || response.Message || errorCode;
|
|
3169
|
+
response.message = message;
|
|
3170
|
+
delete response.Message;
|
|
3171
|
+
return [2, Promise.reject(Object.assign(new Error(message), response))];
|
|
3172
|
+
}
|
|
3173
|
+
});
|
|
3174
|
+
}); };
|
|
3012
3175
|
export var deserializeAws_restJson1CreateGeofenceCollectionCommand = function (output, context) { return __awaiter(void 0, void 0, void 0, function () {
|
|
3013
3176
|
var contents, data, _a, _b;
|
|
3014
3177
|
return __generator(this, function (_c) {
|
|
@@ -7542,6 +7705,16 @@ var serializeAws_restJson1PositionalAccuracy = function (input, context) {
|
|
|
7542
7705
|
return __assign({}, (input.Horizontal !== undefined &&
|
|
7543
7706
|
input.Horizontal !== null && { Horizontal: __serializeFloat(input.Horizontal) }));
|
|
7544
7707
|
};
|
|
7708
|
+
var serializeAws_restJson1PositionList = function (input, context) {
|
|
7709
|
+
return input
|
|
7710
|
+
.filter(function (e) { return e != null; })
|
|
7711
|
+
.map(function (entry) {
|
|
7712
|
+
if (entry === null) {
|
|
7713
|
+
return null;
|
|
7714
|
+
}
|
|
7715
|
+
return serializeAws_restJson1Position(entry, context);
|
|
7716
|
+
});
|
|
7717
|
+
};
|
|
7545
7718
|
var serializeAws_restJson1PropertyMap = function (input, context) {
|
|
7546
7719
|
return Object.entries(input).reduce(function (acc, _a) {
|
|
7547
7720
|
var _b;
|
|
@@ -7739,6 +7912,14 @@ var deserializeAws_restJson1BoundingBox = function (output, context) {
|
|
|
7739
7912
|
return __limitedParseDouble(entry);
|
|
7740
7913
|
});
|
|
7741
7914
|
};
|
|
7915
|
+
var deserializeAws_restJson1CalculateRouteMatrixSummary = function (output, context) {
|
|
7916
|
+
return {
|
|
7917
|
+
DataSource: __expectString(output.DataSource),
|
|
7918
|
+
DistanceUnit: __expectString(output.DistanceUnit),
|
|
7919
|
+
ErrorCount: __expectInt32(output.ErrorCount),
|
|
7920
|
+
RouteCount: __expectInt32(output.RouteCount),
|
|
7921
|
+
};
|
|
7922
|
+
};
|
|
7742
7923
|
var deserializeAws_restJson1CalculateRouteSummary = function (output, context) {
|
|
7743
7924
|
return {
|
|
7744
7925
|
DataSource: __expectString(output.DataSource),
|
|
@@ -8086,6 +8267,16 @@ var deserializeAws_restJson1PositionalAccuracy = function (output, context) {
|
|
|
8086
8267
|
Horizontal: __limitedParseDouble(output.Horizontal),
|
|
8087
8268
|
};
|
|
8088
8269
|
};
|
|
8270
|
+
var deserializeAws_restJson1PositionList = function (output, context) {
|
|
8271
|
+
return (output || [])
|
|
8272
|
+
.filter(function (e) { return e != null; })
|
|
8273
|
+
.map(function (entry) {
|
|
8274
|
+
if (entry === null) {
|
|
8275
|
+
return null;
|
|
8276
|
+
}
|
|
8277
|
+
return deserializeAws_restJson1Position(entry, context);
|
|
8278
|
+
});
|
|
8279
|
+
};
|
|
8089
8280
|
var deserializeAws_restJson1PropertyMap = function (output, context) {
|
|
8090
8281
|
return Object.entries(output).reduce(function (acc, _a) {
|
|
8091
8282
|
var _b;
|
|
@@ -8096,6 +8287,41 @@ var deserializeAws_restJson1PropertyMap = function (output, context) {
|
|
|
8096
8287
|
return __assign(__assign({}, acc), (_b = {}, _b[key] = __expectString(value), _b));
|
|
8097
8288
|
}, {});
|
|
8098
8289
|
};
|
|
8290
|
+
var deserializeAws_restJson1RouteMatrix = function (output, context) {
|
|
8291
|
+
return (output || [])
|
|
8292
|
+
.filter(function (e) { return e != null; })
|
|
8293
|
+
.map(function (entry) {
|
|
8294
|
+
if (entry === null) {
|
|
8295
|
+
return null;
|
|
8296
|
+
}
|
|
8297
|
+
return deserializeAws_restJson1RouteMatrixRow(entry, context);
|
|
8298
|
+
});
|
|
8299
|
+
};
|
|
8300
|
+
var deserializeAws_restJson1RouteMatrixEntry = function (output, context) {
|
|
8301
|
+
return {
|
|
8302
|
+
Distance: __limitedParseDouble(output.Distance),
|
|
8303
|
+
DurationSeconds: __limitedParseDouble(output.DurationSeconds),
|
|
8304
|
+
Error: output.Error !== undefined && output.Error !== null
|
|
8305
|
+
? deserializeAws_restJson1RouteMatrixEntryError(output.Error, context)
|
|
8306
|
+
: undefined,
|
|
8307
|
+
};
|
|
8308
|
+
};
|
|
8309
|
+
var deserializeAws_restJson1RouteMatrixEntryError = function (output, context) {
|
|
8310
|
+
return {
|
|
8311
|
+
Code: __expectString(output.Code),
|
|
8312
|
+
Message: __expectString(output.Message),
|
|
8313
|
+
};
|
|
8314
|
+
};
|
|
8315
|
+
var deserializeAws_restJson1RouteMatrixRow = function (output, context) {
|
|
8316
|
+
return (output || [])
|
|
8317
|
+
.filter(function (e) { return e != null; })
|
|
8318
|
+
.map(function (entry) {
|
|
8319
|
+
if (entry === null) {
|
|
8320
|
+
return null;
|
|
8321
|
+
}
|
|
8322
|
+
return deserializeAws_restJson1RouteMatrixEntry(entry, context);
|
|
8323
|
+
});
|
|
8324
|
+
};
|
|
8099
8325
|
var deserializeAws_restJson1SearchForPositionResult = function (output, context) {
|
|
8100
8326
|
return {
|
|
8101
8327
|
Distance: __limitedParseDouble(output.Distance),
|
package/dist-types/Location.d.ts
CHANGED
|
@@ -7,6 +7,7 @@ import { BatchGetDevicePositionCommandInput, BatchGetDevicePositionCommandOutput
|
|
|
7
7
|
import { BatchPutGeofenceCommandInput, BatchPutGeofenceCommandOutput } from "./commands/BatchPutGeofenceCommand";
|
|
8
8
|
import { BatchUpdateDevicePositionCommandInput, BatchUpdateDevicePositionCommandOutput } from "./commands/BatchUpdateDevicePositionCommand";
|
|
9
9
|
import { CalculateRouteCommandInput, CalculateRouteCommandOutput } from "./commands/CalculateRouteCommand";
|
|
10
|
+
import { CalculateRouteMatrixCommandInput, CalculateRouteMatrixCommandOutput } from "./commands/CalculateRouteMatrixCommand";
|
|
10
11
|
import { CreateGeofenceCollectionCommandInput, CreateGeofenceCollectionCommandOutput } from "./commands/CreateGeofenceCollectionCommand";
|
|
11
12
|
import { CreateMapCommandInput, CreateMapCommandOutput } from "./commands/CreateMapCommand";
|
|
12
13
|
import { CreatePlaceIndexCommandInput, CreatePlaceIndexCommandOutput } from "./commands/CreatePlaceIndexCommand";
|
|
@@ -152,7 +153,7 @@ export declare class Location extends LocationClient {
|
|
|
152
153
|
/**
|
|
153
154
|
* <p>
|
|
154
155
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters:
|
|
155
|
-
* <code>
|
|
156
|
+
* <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that
|
|
156
157
|
* you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
157
158
|
* route calculator resource</a>.</p>
|
|
158
159
|
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
@@ -161,29 +162,72 @@ export declare class Location extends LocationClient {
|
|
|
161
162
|
* <ul>
|
|
162
163
|
* <li>
|
|
163
164
|
* <p>
|
|
164
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/
|
|
165
|
-
*
|
|
166
|
-
*
|
|
165
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code>
|
|
166
|
+
* or <code>DepartNow</code>. This calculates a route based on predictive traffic
|
|
167
|
+
* data at the given time. </p>
|
|
167
168
|
* <note>
|
|
168
169
|
* <p>You can't specify both <code>DepartureTime</code> and
|
|
169
|
-
* <code>
|
|
170
|
-
*
|
|
170
|
+
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
171
|
+
* returns a validation error.</p>
|
|
171
172
|
* </note>
|
|
172
173
|
* </li>
|
|
173
174
|
* <li>
|
|
174
175
|
* <p>
|
|
175
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
* <code>Truck</code>.</p>
|
|
176
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
|
|
177
|
+
* mode used to calculate the routes. This also lets you specify additional route
|
|
178
|
+
* preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
179
|
+
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
179
180
|
* </li>
|
|
180
181
|
* </ul>
|
|
181
|
-
* <p>
|
|
182
|
-
* </p>
|
|
183
182
|
*/
|
|
184
183
|
calculateRoute(args: CalculateRouteCommandInput, options?: __HttpHandlerOptions): Promise<CalculateRouteCommandOutput>;
|
|
185
184
|
calculateRoute(args: CalculateRouteCommandInput, cb: (err: any, data?: CalculateRouteCommandOutput) => void): void;
|
|
186
185
|
calculateRoute(args: CalculateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteCommandOutput) => void): void;
|
|
186
|
+
/**
|
|
187
|
+
* <p>
|
|
188
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a
|
|
189
|
+
* route matrix</a> given the following required parameters:
|
|
190
|
+
* <code>DeparturePositions</code> and <code>DestinationPositions</code>.
|
|
191
|
+
* <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
|
|
192
|
+
* travel distance from each departure position to each destination position in the
|
|
193
|
+
* request. For example, given departure positions A and B, and destination positions
|
|
194
|
+
* X and Y, <code>CalculateRouteMatrix</code> will return time and distance for routes
|
|
195
|
+
* from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned
|
|
196
|
+
* (and routes calculated) will be the number of <code>DeparturePositions</code>
|
|
197
|
+
* times the number of <code>DestinationPositions</code>.</p>
|
|
198
|
+
* <note>
|
|
199
|
+
* <p>Your account is charged for each route calculated, not the number of requests.</p>
|
|
200
|
+
* </note>
|
|
201
|
+
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
202
|
+
* route calculator resource</a>.</p>
|
|
203
|
+
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
204
|
+
* to travel with the best traffic conditions when calculating routes.</p>
|
|
205
|
+
* <p>Additional options include:</p>
|
|
206
|
+
* <ul>
|
|
207
|
+
* <li>
|
|
208
|
+
* <p>
|
|
209
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">
|
|
210
|
+
* Specifying a departure time</a> using either <code>DepartureTime</code>
|
|
211
|
+
* or <code>DepartNow</code>. This calculates routes based on predictive traffic
|
|
212
|
+
* data at the given time. </p>
|
|
213
|
+
* <note>
|
|
214
|
+
* <p>You can't specify both <code>DepartureTime</code> and
|
|
215
|
+
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
216
|
+
* returns a validation error.</p>
|
|
217
|
+
* </note>
|
|
218
|
+
* </li>
|
|
219
|
+
* <li>
|
|
220
|
+
* <p>
|
|
221
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
|
|
222
|
+
* mode used to calculate the routes. This also lets you specify additional route
|
|
223
|
+
* preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
224
|
+
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
225
|
+
* </li>
|
|
226
|
+
* </ul>
|
|
227
|
+
*/
|
|
228
|
+
calculateRouteMatrix(args: CalculateRouteMatrixCommandInput, options?: __HttpHandlerOptions): Promise<CalculateRouteMatrixCommandOutput>;
|
|
229
|
+
calculateRouteMatrix(args: CalculateRouteMatrixCommandInput, cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void): void;
|
|
230
|
+
calculateRouteMatrix(args: CalculateRouteMatrixCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void): void;
|
|
187
231
|
/**
|
|
188
232
|
* <p>Creates a geofence collection, which manages and stores geofences.</p>
|
|
189
233
|
*/
|
|
@@ -193,6 +237,12 @@ export declare class Location extends LocationClient {
|
|
|
193
237
|
/**
|
|
194
238
|
* <p>Creates a map resource in your AWS account, which provides map tiles of different
|
|
195
239
|
* styles sourced from global location data providers.</p>
|
|
240
|
+
* <note>
|
|
241
|
+
* <p>If your application is tracking or routing assets you use in your business, such
|
|
242
|
+
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
243
|
+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
244
|
+
* service terms</a> for more details.</p>
|
|
245
|
+
* </note>
|
|
196
246
|
*/
|
|
197
247
|
createMap(args: CreateMapCommandInput, options?: __HttpHandlerOptions): Promise<CreateMapCommandOutput>;
|
|
198
248
|
createMap(args: CreateMapCommandInput, cb: (err: any, data?: CreateMapCommandOutput) => void): void;
|
|
@@ -202,6 +252,12 @@ export declare class Location extends LocationClient {
|
|
|
202
252
|
* geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,
|
|
203
253
|
* and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and
|
|
204
254
|
* enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
255
|
+
* <note>
|
|
256
|
+
* <p>If your application is tracking or routing assets you use in your business, such
|
|
257
|
+
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
258
|
+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
259
|
+
* service terms</a> for more details.</p>
|
|
260
|
+
* </note>
|
|
205
261
|
*/
|
|
206
262
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlaceIndexCommandOutput>;
|
|
207
263
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
|
|
@@ -211,6 +267,12 @@ export declare class Location extends LocationClient {
|
|
|
211
267
|
* <p>You can send requests to a route calculator resource to estimate travel time,
|
|
212
268
|
* distance, and get directions. A route calculator sources traffic and road network data
|
|
213
269
|
* from your chosen data provider.</p>
|
|
270
|
+
* <note>
|
|
271
|
+
* <p>If your application is tracking or routing assets you use in your business, such
|
|
272
|
+
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
273
|
+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
274
|
+
* service terms</a> for more details.</p>
|
|
275
|
+
* </note>
|
|
214
276
|
*/
|
|
215
277
|
createRouteCalculator(args: CreateRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<CreateRouteCalculatorCommandOutput>;
|
|
216
278
|
createRouteCalculator(args: CreateRouteCalculatorCommandInput, cb: (err: any, data?: CreateRouteCalculatorCommandOutput) => void): void;
|
|
@@ -14,6 +14,7 @@ import { BatchGetDevicePositionCommandInput, BatchGetDevicePositionCommandOutput
|
|
|
14
14
|
import { BatchPutGeofenceCommandInput, BatchPutGeofenceCommandOutput } from "./commands/BatchPutGeofenceCommand";
|
|
15
15
|
import { BatchUpdateDevicePositionCommandInput, BatchUpdateDevicePositionCommandOutput } from "./commands/BatchUpdateDevicePositionCommand";
|
|
16
16
|
import { CalculateRouteCommandInput, CalculateRouteCommandOutput } from "./commands/CalculateRouteCommand";
|
|
17
|
+
import { CalculateRouteMatrixCommandInput, CalculateRouteMatrixCommandOutput } from "./commands/CalculateRouteMatrixCommand";
|
|
17
18
|
import { CreateGeofenceCollectionCommandInput, CreateGeofenceCollectionCommandOutput } from "./commands/CreateGeofenceCollectionCommand";
|
|
18
19
|
import { CreateMapCommandInput, CreateMapCommandOutput } from "./commands/CreateMapCommand";
|
|
19
20
|
import { CreatePlaceIndexCommandInput, CreatePlaceIndexCommandOutput } from "./commands/CreatePlaceIndexCommand";
|
|
@@ -57,8 +58,8 @@ import { UpdateMapCommandInput, UpdateMapCommandOutput } from "./commands/Update
|
|
|
57
58
|
import { UpdatePlaceIndexCommandInput, UpdatePlaceIndexCommandOutput } from "./commands/UpdatePlaceIndexCommand";
|
|
58
59
|
import { UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput } from "./commands/UpdateRouteCalculatorCommand";
|
|
59
60
|
import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./commands/UpdateTrackerCommand";
|
|
60
|
-
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;
|
|
61
|
-
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;
|
|
61
|
+
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;
|
|
62
|
+
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;
|
|
62
63
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
63
64
|
/**
|
|
64
65
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -9,7 +9,7 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>
|
|
11
11
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters:
|
|
12
|
-
* <code>
|
|
12
|
+
* <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that
|
|
13
13
|
* you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
14
14
|
* route calculator resource</a>.</p>
|
|
15
15
|
* <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
|
|
|
18
18
|
* <ul>
|
|
19
19
|
* <li>
|
|
20
20
|
* <p>
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/
|
|
22
|
-
*
|
|
23
|
-
*
|
|
21
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a departure time</a> using either <code>DepartureTime</code>
|
|
22
|
+
* or <code>DepartNow</code>. This calculates a route based on predictive traffic
|
|
23
|
+
* data at the given time. </p>
|
|
24
24
|
* <note>
|
|
25
25
|
* <p>You can't specify both <code>DepartureTime</code> and
|
|
26
|
-
* <code>
|
|
27
|
-
*
|
|
26
|
+
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
27
|
+
* returns a validation error.</p>
|
|
28
28
|
* </note>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
31
|
* <p>
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* <code>Truck</code>.</p>
|
|
32
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
|
|
33
|
+
* mode used to calculate the routes. This also lets you specify additional route
|
|
34
|
+
* preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
35
|
+
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
36
36
|
* </li>
|
|
37
37
|
* </ul>
|
|
38
|
-
* <p>
|
|
39
|
-
* </p>
|
|
40
38
|
* @example
|
|
41
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
40
|
* ```javascript
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
|
|
4
|
+
import { CalculateRouteMatrixRequest, CalculateRouteMatrixResponse } from "../models/models_0";
|
|
5
|
+
export interface CalculateRouteMatrixCommandInput extends CalculateRouteMatrixRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a
|
|
12
|
+
* route matrix</a> given the following required parameters:
|
|
13
|
+
* <code>DeparturePositions</code> and <code>DestinationPositions</code>.
|
|
14
|
+
* <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
|
|
15
|
+
* travel distance from each departure position to each destination position in the
|
|
16
|
+
* request. For example, given departure positions A and B, and destination positions
|
|
17
|
+
* X and Y, <code>CalculateRouteMatrix</code> will return time and distance for routes
|
|
18
|
+
* from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned
|
|
19
|
+
* (and routes calculated) will be the number of <code>DeparturePositions</code>
|
|
20
|
+
* times the number of <code>DestinationPositions</code>.</p>
|
|
21
|
+
* <note>
|
|
22
|
+
* <p>Your account is charged for each route calculated, not the number of requests.</p>
|
|
23
|
+
* </note>
|
|
24
|
+
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
25
|
+
* route calculator resource</a>.</p>
|
|
26
|
+
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
27
|
+
* to travel with the best traffic conditions when calculating routes.</p>
|
|
28
|
+
* <p>Additional options include:</p>
|
|
29
|
+
* <ul>
|
|
30
|
+
* <li>
|
|
31
|
+
* <p>
|
|
32
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">
|
|
33
|
+
* Specifying a departure time</a> using either <code>DepartureTime</code>
|
|
34
|
+
* or <code>DepartNow</code>. This calculates routes based on predictive traffic
|
|
35
|
+
* data at the given time. </p>
|
|
36
|
+
* <note>
|
|
37
|
+
* <p>You can't specify both <code>DepartureTime</code> and
|
|
38
|
+
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
39
|
+
* returns a validation error.</p>
|
|
40
|
+
* </note>
|
|
41
|
+
* </li>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>
|
|
44
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel mode</a> using TravelMode sets the transportation
|
|
45
|
+
* mode used to calculate the routes. This also lets you specify additional route
|
|
46
|
+
* preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
47
|
+
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
50
|
+
* @example
|
|
51
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
52
|
+
* ```javascript
|
|
53
|
+
* import { LocationClient, CalculateRouteMatrixCommand } from "@aws-sdk/client-location"; // ES Modules import
|
|
54
|
+
* // const { LocationClient, CalculateRouteMatrixCommand } = require("@aws-sdk/client-location"); // CommonJS import
|
|
55
|
+
* const client = new LocationClient(config);
|
|
56
|
+
* const command = new CalculateRouteMatrixCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @see {@link CalculateRouteMatrixCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link CalculateRouteMatrixCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
*/
|
|
65
|
+
export declare class CalculateRouteMatrixCommand extends $Command<CalculateRouteMatrixCommandInput, CalculateRouteMatrixCommandOutput, LocationClientResolvedConfig> {
|
|
66
|
+
readonly input: CalculateRouteMatrixCommandInput;
|
|
67
|
+
constructor(input: CalculateRouteMatrixCommandInput);
|
|
68
|
+
/**
|
|
69
|
+
* @internal
|
|
70
|
+
*/
|
|
71
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CalculateRouteMatrixCommandInput, CalculateRouteMatrixCommandOutput>;
|
|
72
|
+
private serialize;
|
|
73
|
+
private deserialize;
|
|
74
|
+
}
|
|
@@ -9,6 +9,12 @@ export interface CreateMapCommandOutput extends CreateMapResponse, __MetadataBea
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a map resource in your AWS account, which provides map tiles of different
|
|
11
11
|
* styles sourced from global location data providers.</p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>If your application is tracking or routing assets you use in your business, such
|
|
14
|
+
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
15
|
+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
16
|
+
* service terms</a> for more details.</p>
|
|
17
|
+
* </note>
|
|
12
18
|
* @example
|
|
13
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
20
|
* ```javascript
|
|
@@ -11,6 +11,12 @@ export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse,
|
|
|
11
11
|
* geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,
|
|
12
12
|
* and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and
|
|
13
13
|
* enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>If your application is tracking or routing assets you use in your business, such
|
|
16
|
+
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
17
|
+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
18
|
+
* service terms</a> for more details.</p>
|
|
19
|
+
* </note>
|
|
14
20
|
* @example
|
|
15
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
22
|
* ```javascript
|
|
@@ -11,6 +11,12 @@ export interface CreateRouteCalculatorCommandOutput extends CreateRouteCalculato
|
|
|
11
11
|
* <p>You can send requests to a route calculator resource to estimate travel time,
|
|
12
12
|
* distance, and get directions. A route calculator sources traffic and road network data
|
|
13
13
|
* from your chosen data provider.</p>
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>If your application is tracking or routing assets you use in your business, such
|
|
16
|
+
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
17
|
+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
18
|
+
* service terms</a> for more details.</p>
|
|
19
|
+
* </note>
|
|
14
20
|
* @example
|
|
15
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
22
|
* ```javascript
|
|
@@ -6,6 +6,7 @@ export * from "./BatchGetDevicePositionCommand";
|
|
|
6
6
|
export * from "./BatchPutGeofenceCommand";
|
|
7
7
|
export * from "./BatchUpdateDevicePositionCommand";
|
|
8
8
|
export * from "./CalculateRouteCommand";
|
|
9
|
+
export * from "./CalculateRouteMatrixCommand";
|
|
9
10
|
export * from "./CreateGeofenceCollectionCommand";
|
|
10
11
|
export * from "./CreateMapCommand";
|
|
11
12
|
export * from "./CreatePlaceIndexCommand";
|