@aws-sdk/client-location 3.916.0 → 3.917.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 +1 -1
- package/dist-cjs/index.js +96 -0
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +89 -0
- package/dist-types/commands/AssociateTrackerConsumerCommand.d.ts +3 -11
- package/dist-types/commands/BatchDeleteDevicePositionHistoryCommand.d.ts +1 -2
- package/dist-types/commands/BatchDeleteGeofenceCommand.d.ts +2 -6
- package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +2 -32
- package/dist-types/commands/BatchGetDevicePositionCommand.d.ts +1 -2
- package/dist-types/commands/BatchPutGeofenceCommand.d.ts +2 -5
- package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +2 -25
- package/dist-types/commands/CalculateRouteCommand.d.ts +2 -36
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +2 -44
- package/dist-types/commands/CreateGeofenceCollectionCommand.d.ts +2 -4
- package/dist-types/commands/CreateKeyCommand.d.ts +14 -9
- package/dist-types/commands/CreateMapCommand.d.ts +3 -12
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +3 -15
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +3 -14
- package/dist-types/commands/CreateTrackerCommand.d.ts +3 -6
- package/dist-types/commands/DeleteGeofenceCollectionCommand.d.ts +2 -7
- package/dist-types/commands/DeleteKeyCommand.d.ts +2 -4
- package/dist-types/commands/DeleteMapCommand.d.ts +2 -7
- package/dist-types/commands/DeletePlaceIndexCommand.d.ts +2 -6
- package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +2 -6
- package/dist-types/commands/DeleteTrackerCommand.d.ts +2 -8
- package/dist-types/commands/DescribeGeofenceCollectionCommand.d.ts +1 -2
- package/dist-types/commands/DescribeKeyCommand.d.ts +13 -3
- package/dist-types/commands/DescribeMapCommand.d.ts +2 -3
- package/dist-types/commands/DescribePlaceIndexCommand.d.ts +2 -3
- package/dist-types/commands/DescribeRouteCalculatorCommand.d.ts +2 -3
- package/dist-types/commands/DescribeTrackerCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateTrackerConsumerCommand.d.ts +2 -7
- package/dist-types/commands/ForecastGeofenceEventsCommand.d.ts +2 -22
- package/dist-types/commands/GetDevicePositionCommand.d.ts +2 -6
- package/dist-types/commands/GetDevicePositionHistoryCommand.d.ts +2 -7
- package/dist-types/commands/GetGeofenceCommand.d.ts +2 -7
- package/dist-types/commands/GetMapGlyphsCommand.d.ts +2 -3
- package/dist-types/commands/GetMapSpritesCommand.d.ts +2 -5
- package/dist-types/commands/GetMapStyleDescriptorCommand.d.ts +2 -6
- package/dist-types/commands/GetMapTileCommand.d.ts +2 -8
- package/dist-types/commands/GetPlaceCommand.d.ts +2 -25
- package/dist-types/commands/ListDevicePositionsCommand.d.ts +1 -2
- package/dist-types/commands/ListGeofenceCollectionsCommand.d.ts +1 -2
- package/dist-types/commands/ListGeofencesCommand.d.ts +1 -2
- package/dist-types/commands/ListKeysCommand.d.ts +13 -3
- package/dist-types/commands/ListMapsCommand.d.ts +2 -3
- package/dist-types/commands/ListPlaceIndexesCommand.d.ts +2 -3
- package/dist-types/commands/ListRouteCalculatorsCommand.d.ts +2 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
- package/dist-types/commands/ListTrackerConsumersCommand.d.ts +1 -2
- package/dist-types/commands/ListTrackersCommand.d.ts +1 -2
- package/dist-types/commands/PutGeofenceCommand.d.ts +2 -4
- package/dist-types/commands/SearchPlaceIndexForPositionCommand.d.ts +2 -4
- package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +2 -14
- package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +2 -12
- package/dist-types/commands/TagResourceCommand.d.ts +2 -13
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
- package/dist-types/commands/UpdateGeofenceCollectionCommand.d.ts +1 -2
- package/dist-types/commands/UpdateKeyCommand.d.ts +12 -2
- package/dist-types/commands/UpdateMapCommand.d.ts +2 -3
- package/dist-types/commands/UpdatePlaceIndexCommand.d.ts +2 -3
- package/dist-types/commands/UpdateRouteCalculatorCommand.d.ts +2 -3
- package/dist-types/commands/UpdateTrackerCommand.d.ts +1 -2
- package/dist-types/commands/VerifyDevicePositionCommand.d.ts +2 -8
- package/dist-types/models/models_0.d.ts +444 -2825
- package/dist-types/ts3.4/models/models_0.d.ts +26 -0
- package/package.json +2 -2
|
@@ -27,29 +27,7 @@ declare const BatchUpdateDevicePositionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Uploads position update data for one or more devices to a tracker resource (up to
|
|
31
|
-
* 10 devices per batch). Amazon Location uses the data when it reports the last known device
|
|
32
|
-
* position and position history. Amazon Location retains location data for 30 days.</p>
|
|
33
|
-
* <note>
|
|
34
|
-
* <p>Position updates are handled based on the <code>PositionFiltering</code>
|
|
35
|
-
* property of the tracker. When <code>PositionFiltering</code> is set to
|
|
36
|
-
* <code>TimeBased</code>, updates are evaluated against linked geofence collections,
|
|
37
|
-
* and location data is stored at a maximum of one position per 30 second interval.
|
|
38
|
-
* If your update frequency is more often than every 30 seconds, only one update per
|
|
39
|
-
* 30 seconds is stored for each unique device ID.</p>
|
|
40
|
-
* <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code>
|
|
41
|
-
* filtering, location data is stored and evaluated against linked geofence
|
|
42
|
-
* collections only if the device has moved more than 30 m (98.4 ft).</p>
|
|
43
|
-
* <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code>
|
|
44
|
-
* filtering, location data is stored and evaluated against linked geofence
|
|
45
|
-
* collections only if the device has moved more than the measured accuracy. For
|
|
46
|
-
* example, if two consecutive updates from a device have a horizontal accuracy of
|
|
47
|
-
* 5 m and 10 m, the second update is neither stored or evaluated if the device has
|
|
48
|
-
* moved less than 15 m. If <code>PositionFiltering</code> is set to
|
|
49
|
-
* <code>AccuracyBased</code> filtering, Amazon Location uses the default value
|
|
50
|
-
* <code>\{ "Horizontal": 0\}</code> when accuracy is not provided on a
|
|
51
|
-
* <code>DevicePositionUpdate</code>.</p>
|
|
52
|
-
* </note>
|
|
30
|
+
* <p>Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.</p> <note> <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker. When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p> <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).</p> <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location uses the default value <code>\{ "Horizontal": 0\}</code> when accuracy is not provided on a <code>DevicePositionUpdate</code>.</p> </note>
|
|
53
31
|
* @example
|
|
54
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
55
33
|
* ```javascript
|
|
@@ -100,8 +78,7 @@ declare const BatchUpdateDevicePositionCommand_base: {
|
|
|
100
78
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
101
79
|
*
|
|
102
80
|
* @throws {@link AccessDeniedException} (client fault)
|
|
103
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
104
|
-
* administrator to verify your permissions.</p>
|
|
81
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
105
82
|
*
|
|
106
83
|
* @throws {@link InternalServerException} (server fault)
|
|
107
84
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -27,40 +27,7 @@ declare const CalculateRouteCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <a href="https://docs.aws.amazon.com/location/previous/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters:
|
|
32
|
-
* <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that
|
|
33
|
-
* you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
34
|
-
* route calculator resource</a>.</p>
|
|
35
|
-
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
36
|
-
* to travel with the best traffic conditions when calculating the route.</p>
|
|
37
|
-
* <p>Additional options include:</p>
|
|
38
|
-
* <ul>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* <a href="https://docs.aws.amazon.com/location/previous/developerguide/departure-time.html">Specifying a
|
|
42
|
-
* departure time</a> using either <code>DepartureTime</code> or
|
|
43
|
-
* <code>DepartNow</code>. This calculates a route based on predictive traffic
|
|
44
|
-
* data at the given time. </p>
|
|
45
|
-
* <note>
|
|
46
|
-
* <p>You can't specify both <code>DepartureTime</code> and
|
|
47
|
-
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
48
|
-
* returns a validation error.</p>
|
|
49
|
-
* </note>
|
|
50
|
-
* </li>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>
|
|
53
|
-
* <a href="https://docs.aws.amazon.com/location/previous/developerguide/travel-mode.html">Specifying a travel
|
|
54
|
-
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
55
|
-
* the routes. This also lets you specify additional route preferences in
|
|
56
|
-
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
57
|
-
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
58
|
-
* <note>
|
|
59
|
-
* <p>If you specify <code>walking</code> for the travel mode and your data
|
|
60
|
-
* provider is Esri, the start and destination must be within 40km.</p>
|
|
61
|
-
* </note>
|
|
62
|
-
* </li>
|
|
63
|
-
* </ul>
|
|
30
|
+
* <important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to <a href="/location/latest/APIReference/API_CalculateRoutes.html"> <code>CalculateRoutes</code> </a> or <a href="/location/latest/APIReference/API_CalculateIsolines.html"> <code>CalculateIsolines</code> </a> unless you require Grab data.</p> <ul> <li> <p> <code>CalculateRoute</code> is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The version 2 <code>CalculateRoutes</code> operation gives better results for point-to-point routing, while the version 2 <code>CalculateIsolines</code> operation adds support for calculating service areas and travel time envelopes.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under <code>geo-routes</code> or <code>geo_routes</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> </ul> </important> <p> <a href="https://docs.aws.amazon.com/location/previous/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters: <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 to travel with the best traffic conditions when calculating the route.</p> <p>Additional options include:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/location/previous/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>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/previous/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> <note> <p>If you specify <code>walking</code> for the travel mode and your data provider is Esri, the start and destination must be within 40km.</p> </note> </li> </ul>
|
|
64
31
|
* @example
|
|
65
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
66
33
|
* ```javascript
|
|
@@ -164,8 +131,7 @@ declare const CalculateRouteCommand_base: {
|
|
|
164
131
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
165
132
|
*
|
|
166
133
|
* @throws {@link AccessDeniedException} (client fault)
|
|
167
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
168
|
-
* administrator to verify your permissions.</p>
|
|
134
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
169
135
|
*
|
|
170
136
|
* @throws {@link InternalServerException} (server fault)
|
|
171
137
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -27,48 +27,7 @@ declare const CalculateRouteMatrixCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <a href="https://docs.aws.amazon.com/location/previous/developerguide/calculate-route-matrix.html"> Calculates a route
|
|
32
|
-
* matrix</a> given the following required parameters:
|
|
33
|
-
* <code>DeparturePositions</code> and <code>DestinationPositions</code>.
|
|
34
|
-
* <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
|
|
35
|
-
* travel distance from each departure position to each destination position in the
|
|
36
|
-
* request. For example, given departure positions A and B, and destination positions X and
|
|
37
|
-
* Y, <code>CalculateRouteMatrix</code> will return time and distance for routes from A to
|
|
38
|
-
* X, A to Y, B to X, and B to Y (in that order). The number of results returned (and
|
|
39
|
-
* routes calculated) will be the number of <code>DeparturePositions</code> times the
|
|
40
|
-
* number of <code>DestinationPositions</code>.</p>
|
|
41
|
-
* <note>
|
|
42
|
-
* <p>Your account is charged for each route calculated, not the number of
|
|
43
|
-
* requests.</p>
|
|
44
|
-
* </note>
|
|
45
|
-
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
46
|
-
* route calculator resource</a>.</p>
|
|
47
|
-
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
48
|
-
* to travel with the best traffic conditions when calculating routes.</p>
|
|
49
|
-
* <p>Additional options include:</p>
|
|
50
|
-
* <ul>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>
|
|
53
|
-
* <a href="https://docs.aws.amazon.com/location/previous/developerguide/departure-time.html"> Specifying a
|
|
54
|
-
* departure time</a> using either <code>DepartureTime</code> or
|
|
55
|
-
* <code>DepartNow</code>. This calculates routes based on predictive traffic
|
|
56
|
-
* data at the given time. </p>
|
|
57
|
-
* <note>
|
|
58
|
-
* <p>You can't specify both <code>DepartureTime</code> and
|
|
59
|
-
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
60
|
-
* returns a validation error.</p>
|
|
61
|
-
* </note>
|
|
62
|
-
* </li>
|
|
63
|
-
* <li>
|
|
64
|
-
* <p>
|
|
65
|
-
* <a href="https://docs.aws.amazon.com/location/previous/developerguide/travel-mode.html">Specifying a travel
|
|
66
|
-
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
67
|
-
* the routes. This also lets you specify additional route preferences in
|
|
68
|
-
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
69
|
-
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
70
|
-
* </li>
|
|
71
|
-
* </ul>
|
|
30
|
+
* <important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the <a href="/location/latest/APIReference/API_CalculateRouteMatrix.html">V2 <code>CalculateRouteMatrix</code> </a> unless you require Grab data.</p> <ul> <li> <p>This version of <code>CalculateRouteMatrix</code> is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The version 2 <code>CalculateRouteMatrix</code> operation gives better results for matrix routing calculations.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under <code>geo-routes</code> or <code>geo_routes</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> <li> <p>Start your version 2 API journey with the Routes V2 <a href="/location/latest/APIReference/API_Operations_Amazon_Location_Service_Routes_V2.html">API Reference</a> or the <a href="/location/latest/developerguide/routes.html">Developer Guide</a>.</p> </li> </ul> </important> <p> <a href="https://docs.aws.amazon.com/location/previous/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/previous/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/previous/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>
|
|
72
31
|
* @example
|
|
73
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
74
33
|
* ```javascript
|
|
@@ -155,8 +114,7 @@ declare const CalculateRouteMatrixCommand_base: {
|
|
|
155
114
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
156
115
|
*
|
|
157
116
|
* @throws {@link AccessDeniedException} (client fault)
|
|
158
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
159
|
-
* administrator to verify your permissions.</p>
|
|
117
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
160
118
|
*
|
|
161
119
|
* @throws {@link InternalServerException} (server fault)
|
|
162
120
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -63,8 +63,7 @@ declare const CreateGeofenceCollectionCommand_base: {
|
|
|
63
63
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
67
|
-
* administrator to verify your permissions.</p>
|
|
66
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
68
67
|
*
|
|
69
68
|
* @throws {@link ConflictException} (client fault)
|
|
70
69
|
* <p>The request was unsuccessful because of a conflict.</p>
|
|
@@ -73,8 +72,7 @@ declare const CreateGeofenceCollectionCommand_base: {
|
|
|
73
72
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
74
73
|
*
|
|
75
74
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
76
|
-
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a>
|
|
77
|
-
* set for Amazon Location Service.</p>
|
|
75
|
+
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a> set for Amazon Location Service.</p>
|
|
78
76
|
*
|
|
79
77
|
* @throws {@link ThrottlingException} (client fault)
|
|
80
78
|
* <p>The request was denied because of request throttling.</p>
|
|
@@ -27,11 +27,7 @@ declare const CreateKeyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an API key resource in your Amazon Web Services account, which lets you grant
|
|
31
|
-
* actions for Amazon Location resources to the API key bearer.</p>
|
|
32
|
-
* <note>
|
|
33
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/location/previous/developerguide/using-apikeys.html">Using API keys</a>.</p>
|
|
34
|
-
* </note>
|
|
30
|
+
* <p>Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Use API keys to authenticate</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -52,6 +48,17 @@ declare const CreateKeyCommand_base: {
|
|
|
52
48
|
* AllowReferers: [ // RefererPatternList
|
|
53
49
|
* "STRING_VALUE",
|
|
54
50
|
* ],
|
|
51
|
+
* AllowAndroidApps: [ // AndroidAppList
|
|
52
|
+
* { // AndroidApp
|
|
53
|
+
* Package: "STRING_VALUE", // required
|
|
54
|
+
* CertificateFingerprint: "STRING_VALUE", // required
|
|
55
|
+
* },
|
|
56
|
+
* ],
|
|
57
|
+
* AllowAppleApps: [ // AppleAppList
|
|
58
|
+
* { // AppleApp
|
|
59
|
+
* BundleId: "STRING_VALUE", // required
|
|
60
|
+
* },
|
|
61
|
+
* ],
|
|
55
62
|
* },
|
|
56
63
|
* Description: "STRING_VALUE",
|
|
57
64
|
* ExpireTime: new Date("TIMESTAMP"),
|
|
@@ -78,8 +85,7 @@ declare const CreateKeyCommand_base: {
|
|
|
78
85
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
79
86
|
*
|
|
80
87
|
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
82
|
-
* administrator to verify your permissions.</p>
|
|
88
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
83
89
|
*
|
|
84
90
|
* @throws {@link ConflictException} (client fault)
|
|
85
91
|
* <p>The request was unsuccessful because of a conflict.</p>
|
|
@@ -88,8 +94,7 @@ declare const CreateKeyCommand_base: {
|
|
|
88
94
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
89
95
|
*
|
|
90
96
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
91
|
-
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a>
|
|
92
|
-
* set for Amazon Location Service.</p>
|
|
97
|
+
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a> set for Amazon Location Service.</p>
|
|
93
98
|
*
|
|
94
99
|
* @throws {@link ThrottlingException} (client fault)
|
|
95
100
|
* <p>The request was denied because of request throttling.</p>
|
|
@@ -27,14 +27,7 @@ declare const CreateMapCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a map resource in your Amazon Web Services account, which provides map tiles of different
|
|
31
|
-
* styles sourced from global location data providers.</p>
|
|
32
|
-
* <note>
|
|
33
|
-
* <p>If your application is tracking or routing assets you use in your business, such
|
|
34
|
-
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
35
|
-
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services
|
|
36
|
-
* service terms</a> for more details.</p>
|
|
37
|
-
* </note>
|
|
30
|
+
* <important> <p>This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require <code>Grab</code> data.</p> <ul> <li> <p> <code>CreateMap</code> is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.</p> </li> <li> <p>If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under <code>geo-maps</code> or <code>geo_maps</code>, not under <code>location</code>.</p> </li> <li> <p>Since <code>Grab</code> is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using <code>Grab</code>.</p> </li> <li> <p>Start your version 2 API journey with the <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_Operations_Amazon_Location_Service_Maps_V2.html">Maps V2 API Reference</a> or the <a href="https://docs.aws.amazon.com/location/latest/developerguide/maps.html">Developer Guide</a>.</p> </li> </ul> </important> <p>Creates a map resource in your Amazon Web Services 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 must not use Esri as your geolocation provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services service terms</a> for more details.</p> </note>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -75,8 +68,7 @@ declare const CreateMapCommand_base: {
|
|
|
75
68
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
76
69
|
*
|
|
77
70
|
* @throws {@link AccessDeniedException} (client fault)
|
|
78
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
79
|
-
* administrator to verify your permissions.</p>
|
|
71
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
80
72
|
*
|
|
81
73
|
* @throws {@link ConflictException} (client fault)
|
|
82
74
|
* <p>The request was unsuccessful because of a conflict.</p>
|
|
@@ -85,8 +77,7 @@ declare const CreateMapCommand_base: {
|
|
|
85
77
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
86
78
|
*
|
|
87
79
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
88
|
-
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a>
|
|
89
|
-
* set for Amazon Location Service.</p>
|
|
80
|
+
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a> set for Amazon Location Service.</p>
|
|
90
81
|
*
|
|
91
82
|
* @throws {@link ThrottlingException} (client fault)
|
|
92
83
|
* <p>The request was denied because of request throttling.</p>
|
|
@@ -27,17 +27,7 @@ declare const CreatePlaceIndexCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a place index resource in your Amazon Web Services account. Use a place index resource to
|
|
31
|
-
* geocode addresses and other text queries by using the
|
|
32
|
-
* <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by
|
|
33
|
-
* using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions
|
|
34
|
-
* by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
35
|
-
* <note>
|
|
36
|
-
* <p>If your application is tracking or routing assets you use in your business, such
|
|
37
|
-
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
38
|
-
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services
|
|
39
|
-
* service terms</a> for more details.</p>
|
|
40
|
-
* </note>
|
|
30
|
+
* <important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.</p> <ul> <li> <p> <code>CreatePlaceIndex</code> is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under <code>geo-places</code> or <code>geo_places</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> <li> <p>Start your version 2 API journey with the Places V2 <a href="/location/latest/APIReference/API_Operations_Amazon_Location_Service_Places_V2.html">API Reference</a> or the <a href="/location/latest/developerguide/places.html">Developer Guide</a>.</p> </li> </ul> </important> <p>Creates a place index resource in your Amazon Web Services account. Use a place index resource to 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 must not use Esri as your geolocation provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services service terms</a> for more details.</p> </note>
|
|
41
31
|
* @example
|
|
42
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
33
|
* ```javascript
|
|
@@ -75,8 +65,7 @@ declare const CreatePlaceIndexCommand_base: {
|
|
|
75
65
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
76
66
|
*
|
|
77
67
|
* @throws {@link AccessDeniedException} (client fault)
|
|
78
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
79
|
-
* administrator to verify your permissions.</p>
|
|
68
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
80
69
|
*
|
|
81
70
|
* @throws {@link ConflictException} (client fault)
|
|
82
71
|
* <p>The request was unsuccessful because of a conflict.</p>
|
|
@@ -85,8 +74,7 @@ declare const CreatePlaceIndexCommand_base: {
|
|
|
85
74
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
86
75
|
*
|
|
87
76
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
88
|
-
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a>
|
|
89
|
-
* set for Amazon Location Service.</p>
|
|
77
|
+
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a> set for Amazon Location Service.</p>
|
|
90
78
|
*
|
|
91
79
|
* @throws {@link ThrottlingException} (client fault)
|
|
92
80
|
* <p>The request was denied because of request throttling.</p>
|
|
@@ -27,16 +27,7 @@ declare const CreateRouteCalculatorCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a route calculator resource in your Amazon Web Services account.</p>
|
|
31
|
-
* <p>You can send requests to a route calculator resource to estimate travel time,
|
|
32
|
-
* distance, and get directions. A route calculator sources traffic and road network data
|
|
33
|
-
* from your chosen data provider.</p>
|
|
34
|
-
* <note>
|
|
35
|
-
* <p>If your application is tracking or routing assets you use in your business, such
|
|
36
|
-
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
37
|
-
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services
|
|
38
|
-
* service terms</a> for more details.</p>
|
|
39
|
-
* </note>
|
|
30
|
+
* <important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.</p> <ul> <li> <p> <code>CreateRouteCalculator</code> is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under <code>geo-routes</code> or <code>geo_routes</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> <li> <p>Start your version 2 API journey with the Routes V2 <a href="/location/latest/APIReference/API_Operations_Amazon_Location_Service_Routes_V2.html">API Reference</a> or the <a href="/location/latest/developerguide/routes.html">Developer Guide</a>.</p> </li> </ul> </important> <p>Creates a route calculator resource in your Amazon Web Services account.</p> <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 must not use Esri as your geolocation provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services service terms</a> for more details.</p> </note>
|
|
40
31
|
* @example
|
|
41
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
33
|
* ```javascript
|
|
@@ -71,8 +62,7 @@ declare const CreateRouteCalculatorCommand_base: {
|
|
|
71
62
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
72
63
|
*
|
|
73
64
|
* @throws {@link AccessDeniedException} (client fault)
|
|
74
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
75
|
-
* administrator to verify your permissions.</p>
|
|
65
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
76
66
|
*
|
|
77
67
|
* @throws {@link ConflictException} (client fault)
|
|
78
68
|
* <p>The request was unsuccessful because of a conflict.</p>
|
|
@@ -81,8 +71,7 @@ declare const CreateRouteCalculatorCommand_base: {
|
|
|
81
71
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
82
72
|
*
|
|
83
73
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
84
|
-
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a>
|
|
85
|
-
* set for Amazon Location Service.</p>
|
|
74
|
+
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a> set for Amazon Location Service.</p>
|
|
86
75
|
*
|
|
87
76
|
* @throws {@link ThrottlingException} (client fault)
|
|
88
77
|
* <p>The request was denied because of request throttling.</p>
|
|
@@ -27,8 +27,7 @@ declare const CreateTrackerCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and
|
|
31
|
-
* historical location of devices.</p>
|
|
30
|
+
* <p>Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -67,8 +66,7 @@ declare const CreateTrackerCommand_base: {
|
|
|
67
66
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
68
67
|
*
|
|
69
68
|
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
71
|
-
* administrator to verify your permissions.</p>
|
|
69
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
72
70
|
*
|
|
73
71
|
* @throws {@link ConflictException} (client fault)
|
|
74
72
|
* <p>The request was unsuccessful because of a conflict.</p>
|
|
@@ -77,8 +75,7 @@ declare const CreateTrackerCommand_base: {
|
|
|
77
75
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
78
76
|
*
|
|
79
77
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
80
|
-
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a>
|
|
81
|
-
* set for Amazon Location Service.</p>
|
|
78
|
+
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a> set for Amazon Location Service.</p>
|
|
82
79
|
*
|
|
83
80
|
* @throws {@link ThrottlingException} (client fault)
|
|
84
81
|
* <p>The request was denied because of request throttling.</p>
|
|
@@ -27,11 +27,7 @@ declare const DeleteGeofenceCollectionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a geofence collection from your Amazon Web Services account.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>This operation deletes the resource permanently. If the geofence collection is the
|
|
33
|
-
* target of a tracker resource, the devices will no longer be monitored.</p>
|
|
34
|
-
* </note>
|
|
30
|
+
* <p>Deletes a geofence collection from your Amazon Web Services account.</p> <note> <p>This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.</p> </note>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -56,8 +52,7 @@ declare const DeleteGeofenceCollectionCommand_base: {
|
|
|
56
52
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
57
53
|
*
|
|
58
54
|
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
60
|
-
* administrator to verify your permissions.</p>
|
|
55
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
61
56
|
*
|
|
62
57
|
* @throws {@link InternalServerException} (server fault)
|
|
63
58
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -27,8 +27,7 @@ declare const DeleteKeyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the specified API key. The API key must have been deactivated more than
|
|
31
|
-
* 90 days previously.</p>
|
|
30
|
+
* <p>Deletes the specified API key. The API key must have been deactivated more than 90 days previously.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Use API keys to authenticate</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -54,8 +53,7 @@ declare const DeleteKeyCommand_base: {
|
|
|
54
53
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
55
54
|
*
|
|
56
55
|
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
58
|
-
* administrator to verify your permissions.</p>
|
|
56
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
59
57
|
*
|
|
60
58
|
* @throws {@link InternalServerException} (server fault)
|
|
61
59
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -27,11 +27,7 @@ declare const DeleteMapCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a map resource from your Amazon Web Services account.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>This operation deletes the resource permanently. If the map is being used in an application,
|
|
33
|
-
* the map may not render.</p>
|
|
34
|
-
* </note>
|
|
30
|
+
* <important> <p>This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require <code>Grab</code> data.</p> <ul> <li> <p> <code>DeleteMap</code> is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.</p> </li> <li> <p>If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under <code>geo-maps</code> or <code>geo_maps</code>, not under <code>location</code>.</p> </li> <li> <p>Since <code>Grab</code> is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using <code>Grab</code>.</p> </li> <li> <p>Start your version 2 API journey with the <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_Operations_Amazon_Location_Service_Maps_V2.html">Maps V2 API Reference</a> or the <a href="https://docs.aws.amazon.com/location/latest/developerguide/maps.html">Developer Guide</a>.</p> </li> </ul> </important> <p>Deletes a map resource from your Amazon Web Services account.</p> <note> <p>This operation deletes the resource permanently. If the map is being used in an application, the map may not render.</p> </note>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -56,8 +52,7 @@ declare const DeleteMapCommand_base: {
|
|
|
56
52
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
57
53
|
*
|
|
58
54
|
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
60
|
-
* administrator to verify your permissions.</p>
|
|
55
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
61
56
|
*
|
|
62
57
|
* @throws {@link InternalServerException} (server fault)
|
|
63
58
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -27,10 +27,7 @@ declare const DeletePlaceIndexCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a place index resource from your Amazon Web Services account.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>This operation deletes the resource permanently.</p>
|
|
33
|
-
* </note>
|
|
30
|
+
* <important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.</p> <ul> <li> <p> <code>DeletePlaceIndex</code> is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under <code>geo-places</code> or <code>geo_places</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> <li> <p>Start your version 2 API journey with the Places V2 <a href="/location/latest/APIReference/API_Operations_Amazon_Location_Service_Places_V2.html">API Reference</a> or the <a href="/location/latest/developerguide/places.html">Developer Guide</a>.</p> </li> </ul> </important> <p>Deletes a place index resource from your Amazon Web Services account.</p> <note> <p>This operation deletes the resource permanently.</p> </note>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -55,8 +52,7 @@ declare const DeletePlaceIndexCommand_base: {
|
|
|
55
52
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
56
53
|
*
|
|
57
54
|
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
59
|
-
* administrator to verify your permissions.</p>
|
|
55
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
60
56
|
*
|
|
61
57
|
* @throws {@link InternalServerException} (server fault)
|
|
62
58
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -27,10 +27,7 @@ declare const DeleteRouteCalculatorCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a route calculator resource from your Amazon Web Services account.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>This operation deletes the resource permanently.</p>
|
|
33
|
-
* </note>
|
|
30
|
+
* <important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.</p> <ul> <li> <p> <code>DeleteRouteCalculator</code> is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under <code>geo-routes</code> or <code>geo_routes</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> <li> <p>Start your version 2 API journey with the Routes V2 <a href="/location/latest/APIReference/API_Operations_Amazon_Location_Service_Routes_V2.html">API Reference</a> or the <a href="/location/latest/developerguide/routes.html">Developer Guide</a>.</p> </li> </ul> </important> <p>Deletes a route calculator resource from your Amazon Web Services account.</p> <note> <p>This operation deletes the resource permanently.</p> </note>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -55,8 +52,7 @@ declare const DeleteRouteCalculatorCommand_base: {
|
|
|
55
52
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
56
53
|
*
|
|
57
54
|
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
59
|
-
* administrator to verify your permissions.</p>
|
|
55
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
60
56
|
*
|
|
61
57
|
* @throws {@link InternalServerException} (server fault)
|
|
62
58
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -27,12 +27,7 @@ declare const DeleteTrackerCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a tracker resource from your Amazon Web Services account.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>This operation deletes the resource permanently. If the tracker resource is in use, you may
|
|
33
|
-
* encounter an error. Make sure that the target resource isn't a dependency for your
|
|
34
|
-
* applications.</p>
|
|
35
|
-
* </note>
|
|
30
|
+
* <p>Deletes a tracker resource from your Amazon Web Services account.</p> <note> <p>This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.</p> </note>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -57,8 +52,7 @@ declare const DeleteTrackerCommand_base: {
|
|
|
57
52
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
58
53
|
*
|
|
59
54
|
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
61
|
-
* administrator to verify your permissions.</p>
|
|
55
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
62
56
|
*
|
|
63
57
|
* @throws {@link InternalServerException} (server fault)
|
|
64
58
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -65,8 +65,7 @@ declare const DescribeGeofenceCollectionCommand_base: {
|
|
|
65
65
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
69
|
-
* administrator to verify your permissions.</p>
|
|
68
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
70
69
|
*
|
|
71
70
|
* @throws {@link InternalServerException} (server fault)
|
|
72
71
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
@@ -27,7 +27,7 @@ declare const DescribeKeyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the API key resource details.</p>
|
|
30
|
+
* <p>Retrieves the API key resource details.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Use API keys to authenticate</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -55,6 +55,17 @@ declare const DescribeKeyCommand_base: {
|
|
|
55
55
|
* // AllowReferers: [ // RefererPatternList
|
|
56
56
|
* // "STRING_VALUE",
|
|
57
57
|
* // ],
|
|
58
|
+
* // AllowAndroidApps: [ // AndroidAppList
|
|
59
|
+
* // { // AndroidApp
|
|
60
|
+
* // Package: "STRING_VALUE", // required
|
|
61
|
+
* // CertificateFingerprint: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // AllowAppleApps: [ // AppleAppList
|
|
65
|
+
* // { // AppleApp
|
|
66
|
+
* // BundleId: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
58
69
|
* // },
|
|
59
70
|
* // CreateTime: new Date("TIMESTAMP"), // required
|
|
60
71
|
* // ExpireTime: new Date("TIMESTAMP"), // required
|
|
@@ -74,8 +85,7 @@ declare const DescribeKeyCommand_base: {
|
|
|
74
85
|
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
75
86
|
*
|
|
76
87
|
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
-
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
78
|
-
* administrator to verify your permissions.</p>
|
|
88
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
|
|
79
89
|
*
|
|
80
90
|
* @throws {@link InternalServerException} (server fault)
|
|
81
91
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|