@aws-sdk/client-location 3.241.0 → 3.248.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/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_restJson1.js +12 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_restJson1.js +12 -0
- package/dist-types/Location.d.ts +76 -79
- package/dist-types/commands/AssociateTrackerConsumerCommand.d.ts +3 -3
- package/dist-types/commands/BatchDeleteGeofenceCommand.d.ts +2 -2
- package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +10 -10
- package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +1 -1
- package/dist-types/commands/CalculateRouteCommand.d.ts +9 -9
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +11 -11
- package/dist-types/commands/CreateMapCommand.d.ts +3 -3
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +3 -3
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +4 -4
- package/dist-types/commands/DeleteGeofenceCollectionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteMapCommand.d.ts +1 -1
- package/dist-types/commands/DeletePlaceIndexCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateTrackerConsumerCommand.d.ts +2 -2
- package/dist-types/commands/GetDevicePositionHistoryCommand.d.ts +1 -1
- package/dist-types/commands/GetMapStyleDescriptorCommand.d.ts +1 -1
- package/dist-types/commands/GetMapTileCommand.d.ts +1 -1
- package/dist-types/commands/GetPlaceCommand.d.ts +8 -8
- package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +3 -3
- package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +3 -6
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +586 -485
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +6 -1
- package/package.json +4 -4
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "fn", r = "argv", s = "ref";
|
|
5
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://geo-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://geo.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { type: e, rules: [{ endpoint: { url: "https://geo.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -2062,6 +2062,9 @@ const deserializeAws_restJson1CreateGeofenceCollectionCommandError = async (outp
|
|
|
2062
2062
|
case "InternalServerException":
|
|
2063
2063
|
case "com.amazonaws.location#InternalServerException":
|
|
2064
2064
|
throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
|
|
2065
|
+
case "ServiceQuotaExceededException":
|
|
2066
|
+
case "com.amazonaws.location#ServiceQuotaExceededException":
|
|
2067
|
+
throw await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context);
|
|
2065
2068
|
case "ThrottlingException":
|
|
2066
2069
|
case "com.amazonaws.location#ThrottlingException":
|
|
2067
2070
|
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
@@ -2114,6 +2117,9 @@ const deserializeAws_restJson1CreateMapCommandError = async (output, context) =>
|
|
|
2114
2117
|
case "InternalServerException":
|
|
2115
2118
|
case "com.amazonaws.location#InternalServerException":
|
|
2116
2119
|
throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
|
|
2120
|
+
case "ServiceQuotaExceededException":
|
|
2121
|
+
case "com.amazonaws.location#ServiceQuotaExceededException":
|
|
2122
|
+
throw await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context);
|
|
2117
2123
|
case "ThrottlingException":
|
|
2118
2124
|
case "com.amazonaws.location#ThrottlingException":
|
|
2119
2125
|
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
@@ -2166,6 +2172,9 @@ const deserializeAws_restJson1CreatePlaceIndexCommandError = async (output, cont
|
|
|
2166
2172
|
case "InternalServerException":
|
|
2167
2173
|
case "com.amazonaws.location#InternalServerException":
|
|
2168
2174
|
throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
|
|
2175
|
+
case "ServiceQuotaExceededException":
|
|
2176
|
+
case "com.amazonaws.location#ServiceQuotaExceededException":
|
|
2177
|
+
throw await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context);
|
|
2169
2178
|
case "ThrottlingException":
|
|
2170
2179
|
case "com.amazonaws.location#ThrottlingException":
|
|
2171
2180
|
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
@@ -2218,6 +2227,9 @@ const deserializeAws_restJson1CreateRouteCalculatorCommandError = async (output,
|
|
|
2218
2227
|
case "InternalServerException":
|
|
2219
2228
|
case "com.amazonaws.location#InternalServerException":
|
|
2220
2229
|
throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
|
|
2230
|
+
case "ServiceQuotaExceededException":
|
|
2231
|
+
case "com.amazonaws.location#ServiceQuotaExceededException":
|
|
2232
|
+
throw await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context);
|
|
2221
2233
|
case "ThrottlingException":
|
|
2222
2234
|
case "com.amazonaws.location#ThrottlingException":
|
|
2223
2235
|
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "fn", r = "argv", s = "ref";
|
|
2
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://geo-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://geo.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { type: e, rules: [{ endpoint: { url: "https://geo.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -1994,6 +1994,9 @@ const deserializeAws_restJson1CreateGeofenceCollectionCommandError = async (outp
|
|
|
1994
1994
|
case "InternalServerException":
|
|
1995
1995
|
case "com.amazonaws.location#InternalServerException":
|
|
1996
1996
|
throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
|
|
1997
|
+
case "ServiceQuotaExceededException":
|
|
1998
|
+
case "com.amazonaws.location#ServiceQuotaExceededException":
|
|
1999
|
+
throw await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context);
|
|
1997
2000
|
case "ThrottlingException":
|
|
1998
2001
|
case "com.amazonaws.location#ThrottlingException":
|
|
1999
2002
|
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
@@ -2045,6 +2048,9 @@ const deserializeAws_restJson1CreateMapCommandError = async (output, context) =>
|
|
|
2045
2048
|
case "InternalServerException":
|
|
2046
2049
|
case "com.amazonaws.location#InternalServerException":
|
|
2047
2050
|
throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
|
|
2051
|
+
case "ServiceQuotaExceededException":
|
|
2052
|
+
case "com.amazonaws.location#ServiceQuotaExceededException":
|
|
2053
|
+
throw await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context);
|
|
2048
2054
|
case "ThrottlingException":
|
|
2049
2055
|
case "com.amazonaws.location#ThrottlingException":
|
|
2050
2056
|
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
@@ -2096,6 +2102,9 @@ const deserializeAws_restJson1CreatePlaceIndexCommandError = async (output, cont
|
|
|
2096
2102
|
case "InternalServerException":
|
|
2097
2103
|
case "com.amazonaws.location#InternalServerException":
|
|
2098
2104
|
throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
|
|
2105
|
+
case "ServiceQuotaExceededException":
|
|
2106
|
+
case "com.amazonaws.location#ServiceQuotaExceededException":
|
|
2107
|
+
throw await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context);
|
|
2099
2108
|
case "ThrottlingException":
|
|
2100
2109
|
case "com.amazonaws.location#ThrottlingException":
|
|
2101
2110
|
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
@@ -2147,6 +2156,9 @@ const deserializeAws_restJson1CreateRouteCalculatorCommandError = async (output,
|
|
|
2147
2156
|
case "InternalServerException":
|
|
2148
2157
|
case "com.amazonaws.location#InternalServerException":
|
|
2149
2158
|
throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
|
|
2159
|
+
case "ServiceQuotaExceededException":
|
|
2160
|
+
case "com.amazonaws.location#ServiceQuotaExceededException":
|
|
2161
|
+
throw await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context);
|
|
2150
2162
|
case "ThrottlingException":
|
|
2151
2163
|
case "com.amazonaws.location#ThrottlingException":
|
|
2152
2164
|
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
package/dist-types/Location.d.ts
CHANGED
|
@@ -61,10 +61,10 @@ export declare class Location extends LocationClient {
|
|
|
61
61
|
* <p>Creates an association between a geofence collection and a tracker resource. This
|
|
62
62
|
* allows the tracker resource to communicate location data to the linked geofence
|
|
63
63
|
* collection. </p>
|
|
64
|
-
*
|
|
65
|
-
*
|
|
64
|
+
* <p>You can associate up to five geofence collections to each tracker resource.</p>
|
|
65
|
+
* <note>
|
|
66
66
|
* <p>Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.</p>
|
|
67
|
-
*
|
|
67
|
+
* </note>
|
|
68
68
|
*/
|
|
69
69
|
associateTrackerConsumer(args: AssociateTrackerConsumerCommandInput, options?: __HttpHandlerOptions): Promise<AssociateTrackerConsumerCommandOutput>;
|
|
70
70
|
associateTrackerConsumer(args: AssociateTrackerConsumerCommandInput, cb: (err: any, data?: AssociateTrackerConsumerCommandOutput) => void): void;
|
|
@@ -77,9 +77,9 @@ export declare class Location extends LocationClient {
|
|
|
77
77
|
batchDeleteDevicePositionHistory(args: BatchDeleteDevicePositionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void): void;
|
|
78
78
|
/**
|
|
79
79
|
* <p>Deletes a batch of geofences from a geofence collection.</p>
|
|
80
|
-
*
|
|
80
|
+
* <note>
|
|
81
81
|
* <p>This operation deletes the resource permanently.</p>
|
|
82
|
-
*
|
|
82
|
+
* </note>
|
|
83
83
|
*/
|
|
84
84
|
batchDeleteGeofence(args: BatchDeleteGeofenceCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteGeofenceCommandOutput>;
|
|
85
85
|
batchDeleteGeofence(args: BatchDeleteGeofenceCommandInput, cb: (err: any, data?: BatchDeleteGeofenceCommandOutput) => void): void;
|
|
@@ -87,33 +87,33 @@ export declare class Location extends LocationClient {
|
|
|
87
87
|
/**
|
|
88
88
|
* <p>Evaluates device positions against the geofence geometries from a given geofence
|
|
89
89
|
* collection.</p>
|
|
90
|
-
*
|
|
90
|
+
* <p>This operation always returns an empty response because geofences are asynchronously
|
|
91
91
|
* evaluated. The evaluation determines if the device has entered or exited a geofenced
|
|
92
92
|
* area, and then publishes one of the following events to Amazon EventBridge:</p>
|
|
93
|
-
*
|
|
93
|
+
* <ul>
|
|
94
94
|
* <li>
|
|
95
|
-
*
|
|
95
|
+
* <p>
|
|
96
96
|
* <code>ENTER</code> if Amazon Location determines that the tracked device has entered
|
|
97
97
|
* a geofenced area.</p>
|
|
98
98
|
* </li>
|
|
99
99
|
* <li>
|
|
100
|
-
*
|
|
100
|
+
* <p>
|
|
101
101
|
* <code>EXIT</code> if Amazon Location determines that the tracked device has exited a
|
|
102
102
|
* geofenced area.</p>
|
|
103
103
|
* </li>
|
|
104
104
|
* </ul>
|
|
105
|
-
*
|
|
105
|
+
* <note>
|
|
106
106
|
* <p>The last geofence that a device was observed within is tracked for 30 days after
|
|
107
107
|
* the most recent device position update.</p>
|
|
108
|
-
*
|
|
109
|
-
*
|
|
108
|
+
* </note>
|
|
109
|
+
* <note>
|
|
110
110
|
* <p>Geofence evaluation uses the given device position. It does not account for the
|
|
111
111
|
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
|
|
112
|
-
*
|
|
113
|
-
*
|
|
112
|
+
* </note>
|
|
113
|
+
* <note>
|
|
114
114
|
* <p>The <code>DeviceID</code> is used as a string to represent the device. You do not
|
|
115
115
|
* need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p>
|
|
116
|
-
*
|
|
116
|
+
* </note>
|
|
117
117
|
*/
|
|
118
118
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, options?: __HttpHandlerOptions): Promise<BatchEvaluateGeofencesCommandOutput>;
|
|
119
119
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void): void;
|
|
@@ -136,7 +136,7 @@ export declare class Location extends LocationClient {
|
|
|
136
136
|
* uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30
|
|
137
137
|
* days.</p>
|
|
138
138
|
* <note>
|
|
139
|
-
*
|
|
139
|
+
* <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker.
|
|
140
140
|
* When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections,
|
|
141
141
|
* and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than
|
|
142
142
|
* every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>
|
|
@@ -161,30 +161,30 @@ export declare class Location extends LocationClient {
|
|
|
161
161
|
* <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that
|
|
162
162
|
* you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
163
163
|
* route calculator resource</a>.</p>
|
|
164
|
-
*
|
|
164
|
+
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
165
165
|
* to travel with the best traffic conditions when calculating the route.</p>
|
|
166
|
-
*
|
|
167
|
-
*
|
|
166
|
+
* <p>Additional options include:</p>
|
|
167
|
+
* <ul>
|
|
168
168
|
* <li>
|
|
169
|
-
*
|
|
169
|
+
* <p>
|
|
170
170
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
|
|
171
171
|
* departure time</a> using either <code>DepartureTime</code> or
|
|
172
172
|
* <code>DepartNow</code>. This calculates a route based on predictive traffic
|
|
173
173
|
* data at the given time. </p>
|
|
174
|
-
*
|
|
175
|
-
*
|
|
174
|
+
* <note>
|
|
175
|
+
* <p>You can't specify both <code>DepartureTime</code> and
|
|
176
176
|
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
177
177
|
* returns a validation error.</p>
|
|
178
|
-
*
|
|
178
|
+
* </note>
|
|
179
179
|
* </li>
|
|
180
180
|
* <li>
|
|
181
|
-
*
|
|
181
|
+
* <p>
|
|
182
182
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
183
183
|
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
184
184
|
* the routes. This also lets you specify additional route preferences in
|
|
185
185
|
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
186
186
|
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
187
|
-
*
|
|
187
|
+
* <note>
|
|
188
188
|
* <p>If you specify <code>walking</code> for the travel mode and your data
|
|
189
189
|
* provider is Esri, the start and destination must be within 40km.</p>
|
|
190
190
|
* </note>
|
|
@@ -206,30 +206,30 @@ export declare class Location extends LocationClient {
|
|
|
206
206
|
* X, A to Y, B to X, and B to Y (in that order). The number of results returned (and
|
|
207
207
|
* routes calculated) will be the number of <code>DeparturePositions</code> times the
|
|
208
208
|
* number of <code>DestinationPositions</code>.</p>
|
|
209
|
-
*
|
|
209
|
+
* <note>
|
|
210
210
|
* <p>Your account is charged for each route calculated, not the number of
|
|
211
211
|
* requests.</p>
|
|
212
|
-
*
|
|
213
|
-
*
|
|
212
|
+
* </note>
|
|
213
|
+
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
214
214
|
* route calculator resource</a>.</p>
|
|
215
|
-
*
|
|
215
|
+
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
216
216
|
* to travel with the best traffic conditions when calculating routes.</p>
|
|
217
|
-
*
|
|
218
|
-
*
|
|
217
|
+
* <p>Additional options include:</p>
|
|
218
|
+
* <ul>
|
|
219
219
|
* <li>
|
|
220
|
-
*
|
|
220
|
+
* <p>
|
|
221
221
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html"> Specifying a
|
|
222
222
|
* departure time</a> using either <code>DepartureTime</code> or
|
|
223
223
|
* <code>DepartNow</code>. This calculates routes based on predictive traffic
|
|
224
224
|
* data at the given time. </p>
|
|
225
|
-
*
|
|
226
|
-
*
|
|
225
|
+
* <note>
|
|
226
|
+
* <p>You can't specify both <code>DepartureTime</code> and
|
|
227
227
|
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
228
228
|
* returns a validation error.</p>
|
|
229
|
-
*
|
|
229
|
+
* </note>
|
|
230
230
|
* </li>
|
|
231
231
|
* <li>
|
|
232
|
-
*
|
|
232
|
+
* <p>
|
|
233
233
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
234
234
|
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
235
235
|
* the routes. This also lets you specify additional route preferences in
|
|
@@ -250,12 +250,12 @@ export declare class Location extends LocationClient {
|
|
|
250
250
|
/**
|
|
251
251
|
* <p>Creates a map resource in your AWS account, which provides map tiles of different
|
|
252
252
|
* styles sourced from global location data providers.</p>
|
|
253
|
-
*
|
|
253
|
+
* <note>
|
|
254
254
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
255
|
-
* as delivery vehicles or employees, you
|
|
255
|
+
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
256
256
|
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
257
257
|
* service terms</a> for more details.</p>
|
|
258
|
-
*
|
|
258
|
+
* </note>
|
|
259
259
|
*/
|
|
260
260
|
createMap(args: CreateMapCommandInput, options?: __HttpHandlerOptions): Promise<CreateMapCommandOutput>;
|
|
261
261
|
createMap(args: CreateMapCommandInput, cb: (err: any, data?: CreateMapCommandOutput) => void): void;
|
|
@@ -266,27 +266,27 @@ export declare class Location extends LocationClient {
|
|
|
266
266
|
* <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by
|
|
267
267
|
* using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions
|
|
268
268
|
* by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
269
|
-
*
|
|
269
|
+
* <note>
|
|
270
270
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
271
|
-
* as delivery vehicles or employees, you
|
|
271
|
+
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
272
272
|
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
273
273
|
* service terms</a> for more details.</p>
|
|
274
|
-
*
|
|
274
|
+
* </note>
|
|
275
275
|
*/
|
|
276
276
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlaceIndexCommandOutput>;
|
|
277
277
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
|
|
278
278
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
|
|
279
279
|
/**
|
|
280
280
|
* <p>Creates a route calculator resource in your AWS account.</p>
|
|
281
|
-
*
|
|
281
|
+
* <p>You can send requests to a route calculator resource to estimate travel time,
|
|
282
282
|
* distance, and get directions. A route calculator sources traffic and road network data
|
|
283
283
|
* from your chosen data provider.</p>
|
|
284
|
-
*
|
|
284
|
+
* <note>
|
|
285
285
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
286
|
-
* as delivery vehicles or employees, you
|
|
286
|
+
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
287
287
|
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
288
288
|
* service terms</a> for more details.</p>
|
|
289
|
-
*
|
|
289
|
+
* </note>
|
|
290
290
|
*/
|
|
291
291
|
createRouteCalculator(args: CreateRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<CreateRouteCalculatorCommandOutput>;
|
|
292
292
|
createRouteCalculator(args: CreateRouteCalculatorCommandInput, cb: (err: any, data?: CreateRouteCalculatorCommandOutput) => void): void;
|
|
@@ -300,17 +300,17 @@ export declare class Location extends LocationClient {
|
|
|
300
300
|
createTracker(args: CreateTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrackerCommandOutput) => void): void;
|
|
301
301
|
/**
|
|
302
302
|
* <p>Deletes a geofence collection from your AWS account.</p>
|
|
303
|
-
*
|
|
303
|
+
* <note>
|
|
304
304
|
* <p>This operation deletes the resource permanently. If the geofence collection is the
|
|
305
305
|
* target of a tracker resource, the devices will no longer be monitored.</p>
|
|
306
|
-
*
|
|
306
|
+
* </note>
|
|
307
307
|
*/
|
|
308
308
|
deleteGeofenceCollection(args: DeleteGeofenceCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGeofenceCollectionCommandOutput>;
|
|
309
309
|
deleteGeofenceCollection(args: DeleteGeofenceCollectionCommandInput, cb: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void): void;
|
|
310
310
|
deleteGeofenceCollection(args: DeleteGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void): void;
|
|
311
311
|
/**
|
|
312
312
|
* <p>Deletes a map resource from your AWS account.</p>
|
|
313
|
-
*
|
|
313
|
+
* <note>
|
|
314
314
|
* <p>This operation deletes the resource permanently. If the map is being used in an application,
|
|
315
315
|
* the map may not render.</p>
|
|
316
316
|
* </note>
|
|
@@ -320,18 +320,18 @@ export declare class Location extends LocationClient {
|
|
|
320
320
|
deleteMap(args: DeleteMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMapCommandOutput) => void): void;
|
|
321
321
|
/**
|
|
322
322
|
* <p>Deletes a place index resource from your AWS account.</p>
|
|
323
|
-
*
|
|
323
|
+
* <note>
|
|
324
324
|
* <p>This operation deletes the resource permanently.</p>
|
|
325
|
-
*
|
|
325
|
+
* </note>
|
|
326
326
|
*/
|
|
327
327
|
deletePlaceIndex(args: DeletePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<DeletePlaceIndexCommandOutput>;
|
|
328
328
|
deletePlaceIndex(args: DeletePlaceIndexCommandInput, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void): void;
|
|
329
329
|
deletePlaceIndex(args: DeletePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void): void;
|
|
330
330
|
/**
|
|
331
331
|
* <p>Deletes a route calculator resource from your AWS account.</p>
|
|
332
|
-
*
|
|
332
|
+
* <note>
|
|
333
333
|
* <p>This operation deletes the resource permanently.</p>
|
|
334
|
-
*
|
|
334
|
+
* </note>
|
|
335
335
|
*/
|
|
336
336
|
deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRouteCalculatorCommandOutput>;
|
|
337
337
|
deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, cb: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void): void;
|
|
@@ -379,10 +379,10 @@ export declare class Location extends LocationClient {
|
|
|
379
379
|
describeTracker(args: DescribeTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrackerCommandOutput) => void): void;
|
|
380
380
|
/**
|
|
381
381
|
* <p>Removes the association between a tracker resource and a geofence collection.</p>
|
|
382
|
-
*
|
|
382
|
+
* <note>
|
|
383
383
|
* <p>Once you unlink a tracker resource from a geofence collection, the tracker
|
|
384
384
|
* positions will no longer be automatically evaluated against geofences.</p>
|
|
385
|
-
*
|
|
385
|
+
* </note>
|
|
386
386
|
*/
|
|
387
387
|
disassociateTrackerConsumer(args: DisassociateTrackerConsumerCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateTrackerConsumerCommandOutput>;
|
|
388
388
|
disassociateTrackerConsumer(args: DisassociateTrackerConsumerCommandInput, cb: (err: any, data?: DisassociateTrackerConsumerCommandOutput) => void): void;
|
|
@@ -400,7 +400,7 @@ export declare class Location extends LocationClient {
|
|
|
400
400
|
* <p>Retrieves the device position history from a tracker resource within a specified range
|
|
401
401
|
* of time.</p>
|
|
402
402
|
* <note>
|
|
403
|
-
*
|
|
403
|
+
* <p>Device positions are deleted after 30 days.</p>
|
|
404
404
|
* </note>
|
|
405
405
|
*/
|
|
406
406
|
getDevicePositionHistory(args: GetDevicePositionHistoryCommandInput, options?: __HttpHandlerOptions): Promise<GetDevicePositionHistoryCommandOutput>;
|
|
@@ -428,7 +428,7 @@ export declare class Location extends LocationClient {
|
|
|
428
428
|
getMapSprites(args: GetMapSpritesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapSpritesCommandOutput) => void): void;
|
|
429
429
|
/**
|
|
430
430
|
* <p>Retrieves the map style descriptor from a map resource. </p>
|
|
431
|
-
*
|
|
431
|
+
* <p>The style descriptor contains specifications on how features render on a map. For
|
|
432
432
|
* example, what data to display, what order to display the data in, and the style for the
|
|
433
433
|
* data. Style descriptors follow the Mapbox Style Specification.</p>
|
|
434
434
|
*/
|
|
@@ -439,7 +439,7 @@ export declare class Location extends LocationClient {
|
|
|
439
439
|
* <p>Retrieves a vector data tile from the map resource. Map tiles are used by clients to
|
|
440
440
|
* render a map. they're addressed using a grid arrangement with an X coordinate, Y
|
|
441
441
|
* coordinate, and Z (zoom) level. </p>
|
|
442
|
-
*
|
|
442
|
+
* <p>The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles
|
|
443
443
|
* both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0)
|
|
444
444
|
* will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).</p>
|
|
445
445
|
*/
|
|
@@ -449,21 +449,21 @@ export declare class Location extends LocationClient {
|
|
|
449
449
|
/**
|
|
450
450
|
* <p>Finds a place by its unique ID. A <code>PlaceId</code> is returned by other search
|
|
451
451
|
* operations.</p>
|
|
452
|
-
*
|
|
452
|
+
* <note>
|
|
453
453
|
* <p>A PlaceId is valid only if all of the following are the same in the original
|
|
454
454
|
* search request and the call to <code>GetPlace</code>.</p>
|
|
455
455
|
* <ul>
|
|
456
456
|
* <li>
|
|
457
|
-
*
|
|
458
|
-
*
|
|
457
|
+
* <p>Customer AWS account</p>
|
|
458
|
+
* </li>
|
|
459
459
|
* <li>
|
|
460
|
-
*
|
|
461
|
-
*
|
|
460
|
+
* <p>AWS Region</p>
|
|
461
|
+
* </li>
|
|
462
462
|
* <li>
|
|
463
|
-
*
|
|
464
|
-
*
|
|
463
|
+
* <p>Data provider specified in the place index resource</p>
|
|
464
|
+
* </li>
|
|
465
465
|
* </ul>
|
|
466
|
-
*
|
|
466
|
+
* </note>
|
|
467
467
|
*/
|
|
468
468
|
getPlace(args: GetPlaceCommandInput, options?: __HttpHandlerOptions): Promise<GetPlaceCommandOutput>;
|
|
469
469
|
getPlace(args: GetPlaceCommandInput, cb: (err: any, data?: GetPlaceCommandOutput) => void): void;
|
|
@@ -540,15 +540,15 @@ export declare class Location extends LocationClient {
|
|
|
540
540
|
* <p>Generates suggestions for addresses and points of interest based on partial or
|
|
541
541
|
* misspelled free-form text. This operation is also known as autocomplete, autosuggest, or
|
|
542
542
|
* fuzzy matching.</p>
|
|
543
|
-
*
|
|
543
|
+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
544
544
|
* bias your search toward a specific position on the globe.</p>
|
|
545
|
-
*
|
|
545
|
+
* <note>
|
|
546
546
|
* <p>You can search for suggested place names near a specified position by using
|
|
547
547
|
* <code>BiasPosition</code>, or filter results within a bounding box by using
|
|
548
548
|
* <code>FilterBBox</code>. These parameters are mutually exclusive; using both
|
|
549
549
|
* <code>BiasPosition</code> and <code>FilterBBox</code> in the same command
|
|
550
550
|
* returns an error.</p>
|
|
551
|
-
*
|
|
551
|
+
* </note>
|
|
552
552
|
*/
|
|
553
553
|
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForSuggestionsCommandOutput>;
|
|
554
554
|
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
@@ -556,14 +556,14 @@ export declare class Location extends LocationClient {
|
|
|
556
556
|
/**
|
|
557
557
|
* <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
|
|
558
558
|
* search for Places or points of interest. </p>
|
|
559
|
-
*
|
|
559
|
+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
560
560
|
* bias your search toward a specific position on the globe.</p>
|
|
561
|
-
*
|
|
561
|
+
* <note>
|
|
562
562
|
* <p>You can search for places near a given position using <code>BiasPosition</code>,
|
|
563
563
|
* or filter results within a bounding box using <code>FilterBBox</code>. Providing
|
|
564
564
|
* both parameters simultaneously returns an error.</p>
|
|
565
|
-
*
|
|
566
|
-
*
|
|
565
|
+
* </note>
|
|
566
|
+
* <p>Search results are returned in order of highest to lowest relevance.</p>
|
|
567
567
|
*/
|
|
568
568
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForTextCommandOutput>;
|
|
569
569
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void): void;
|
|
@@ -571,18 +571,15 @@ export declare class Location extends LocationClient {
|
|
|
571
571
|
/**
|
|
572
572
|
* <p>Assigns one or more tags (key-value pairs) to the specified Amazon
|
|
573
573
|
* Location Service resource.</p>
|
|
574
|
-
*
|
|
575
|
-
* <p>Tags can help you organize and categorize your resources.
|
|
574
|
+
* <p>Tags can help you organize and categorize your resources.
|
|
576
575
|
* You can also use them to scope user permissions, by granting a user
|
|
577
576
|
* permission to access or change only resources with certain tag values.</p>
|
|
578
|
-
*
|
|
579
|
-
* <p>You can use the <code>TagResource</code> operation with an Amazon Location Service
|
|
577
|
+
* <p>You can use the <code>TagResource</code> operation with an Amazon Location Service
|
|
580
578
|
* resource that already has tags. If you specify a new tag key for the resource, this tag
|
|
581
579
|
* is appended to the tags already associated with the resource. If you specify a tag key
|
|
582
580
|
* that's already associated with the resource, the new tag value that you specify replaces
|
|
583
581
|
* the previous value for that tag. </p>
|
|
584
|
-
*
|
|
585
|
-
* <p>You can associate up to 50 tags with a resource.</p>
|
|
582
|
+
* <p>You can associate up to 50 tags with a resource.</p>
|
|
586
583
|
*/
|
|
587
584
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
588
585
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
@@ -11,10 +11,10 @@ export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerC
|
|
|
11
11
|
* <p>Creates an association between a geofence collection and a tracker resource. This
|
|
12
12
|
* allows the tracker resource to communicate location data to the linked geofence
|
|
13
13
|
* collection. </p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <p>You can associate up to five geofence collections to each tracker resource.</p>
|
|
15
|
+
* <note>
|
|
16
16
|
* <p>Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.</p>
|
|
17
|
-
*
|
|
17
|
+
* </note>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -9,9 +9,9 @@ export interface BatchDeleteGeofenceCommandOutput extends BatchDeleteGeofenceRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a batch of geofences from a geofence collection.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>This operation deletes the resource permanently.</p>
|
|
14
|
-
*
|
|
14
|
+
* </note>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -10,33 +10,33 @@ export interface BatchEvaluateGeofencesCommandOutput extends BatchEvaluateGeofen
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Evaluates device positions against the geofence geometries from a given geofence
|
|
12
12
|
* collection.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>This operation always returns an empty response because geofences are asynchronously
|
|
14
14
|
* evaluated. The evaluation determines if the device has entered or exited a geofenced
|
|
15
15
|
* area, and then publishes one of the following events to Amazon EventBridge:</p>
|
|
16
|
-
*
|
|
16
|
+
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <p>
|
|
19
19
|
* <code>ENTER</code> if Amazon Location determines that the tracked device has entered
|
|
20
20
|
* a geofenced area.</p>
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>
|
|
24
24
|
* <code>EXIT</code> if Amazon Location determines that the tracked device has exited a
|
|
25
25
|
* geofenced area.</p>
|
|
26
26
|
* </li>
|
|
27
27
|
* </ul>
|
|
28
|
-
*
|
|
28
|
+
* <note>
|
|
29
29
|
* <p>The last geofence that a device was observed within is tracked for 30 days after
|
|
30
30
|
* the most recent device position update.</p>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* </note>
|
|
32
|
+
* <note>
|
|
33
33
|
* <p>Geofence evaluation uses the given device position. It does not account for the
|
|
34
34
|
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
|
|
35
|
-
*
|
|
36
|
-
*
|
|
35
|
+
* </note>
|
|
36
|
+
* <note>
|
|
37
37
|
* <p>The <code>DeviceID</code> is used as a string to represent the device. You do not
|
|
38
38
|
* need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p>
|
|
39
|
-
*
|
|
39
|
+
* </note>
|
|
40
40
|
* @example
|
|
41
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
42
|
* ```javascript
|
|
@@ -12,7 +12,7 @@ export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevic
|
|
|
12
12
|
* uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30
|
|
13
13
|
* days.</p>
|
|
14
14
|
* <note>
|
|
15
|
-
*
|
|
15
|
+
* <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker.
|
|
16
16
|
* When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections,
|
|
17
17
|
* and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than
|
|
18
18
|
* every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>
|