@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
|
@@ -13,30 +13,30 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
|
|
|
13
13
|
* <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that
|
|
14
14
|
* you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
15
15
|
* route calculator resource</a>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
17
17
|
* to travel with the best traffic conditions when calculating the route.</p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* <p>Additional options include:</p>
|
|
19
|
+
* <ul>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>
|
|
22
22
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
|
|
23
23
|
* departure time</a> using either <code>DepartureTime</code> or
|
|
24
24
|
* <code>DepartNow</code>. This calculates a route based on predictive traffic
|
|
25
25
|
* data at the given time. </p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* <note>
|
|
27
|
+
* <p>You can't specify both <code>DepartureTime</code> and
|
|
28
28
|
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
29
29
|
* returns a validation error.</p>
|
|
30
|
-
*
|
|
30
|
+
* </note>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>
|
|
34
34
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
35
35
|
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
36
36
|
* the routes. This also lets you specify additional route preferences in
|
|
37
37
|
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
38
38
|
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
39
|
-
*
|
|
39
|
+
* <note>
|
|
40
40
|
* <p>If you specify <code>walking</code> for the travel mode and your data
|
|
41
41
|
* provider is Esri, the start and destination must be within 40km.</p>
|
|
42
42
|
* </note>
|
|
@@ -19,30 +19,30 @@ export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixR
|
|
|
19
19
|
* X, A to Y, B to X, and B to Y (in that order). The number of results returned (and
|
|
20
20
|
* routes calculated) will be the number of <code>DeparturePositions</code> times the
|
|
21
21
|
* number of <code>DestinationPositions</code>.</p>
|
|
22
|
-
*
|
|
22
|
+
* <note>
|
|
23
23
|
* <p>Your account is charged for each route calculated, not the number of
|
|
24
24
|
* requests.</p>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
25
|
+
* </note>
|
|
26
|
+
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
27
27
|
* route calculator resource</a>.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
29
29
|
* to travel with the best traffic conditions when calculating routes.</p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* <p>Additional options include:</p>
|
|
31
|
+
* <ul>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>
|
|
34
34
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html"> Specifying a
|
|
35
35
|
* departure time</a> using either <code>DepartureTime</code> or
|
|
36
36
|
* <code>DepartNow</code>. This calculates routes based on predictive traffic
|
|
37
37
|
* data at the given time. </p>
|
|
38
|
-
*
|
|
39
|
-
*
|
|
38
|
+
* <note>
|
|
39
|
+
* <p>You can't specify both <code>DepartureTime</code> and
|
|
40
40
|
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
41
41
|
* returns a validation error.</p>
|
|
42
|
-
*
|
|
42
|
+
* </note>
|
|
43
43
|
* </li>
|
|
44
44
|
* <li>
|
|
45
|
-
*
|
|
45
|
+
* <p>
|
|
46
46
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
47
47
|
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
48
48
|
* the routes. This also lets you specify additional route preferences in
|
|
@@ -10,12 +10,12 @@ export interface CreateMapCommandOutput extends CreateMapResponse, __MetadataBea
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a map resource in your AWS account, which provides map tiles of different
|
|
12
12
|
* styles sourced from global location data providers.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
15
|
-
* as delivery vehicles or employees, you
|
|
15
|
+
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
16
16
|
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
17
17
|
* service terms</a> for more details.</p>
|
|
18
|
-
*
|
|
18
|
+
* </note>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -13,12 +13,12 @@ export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse,
|
|
|
13
13
|
* <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by
|
|
14
14
|
* using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions
|
|
15
15
|
* by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
16
|
-
*
|
|
16
|
+
* <note>
|
|
17
17
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
18
|
-
* as delivery vehicles or employees, you
|
|
18
|
+
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
19
19
|
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
20
20
|
* service terms</a> for more details.</p>
|
|
21
|
-
*
|
|
21
|
+
* </note>
|
|
22
22
|
* @example
|
|
23
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
24
|
* ```javascript
|
|
@@ -9,15 +9,15 @@ export interface CreateRouteCalculatorCommandOutput extends CreateRouteCalculato
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a route calculator resource in your AWS account.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You can send requests to a route calculator resource to estimate travel time,
|
|
13
13
|
* distance, and get directions. A route calculator sources traffic and road network data
|
|
14
14
|
* from your chosen data provider.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
17
|
-
* as delivery vehicles or employees, you
|
|
17
|
+
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
18
18
|
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
19
19
|
* service terms</a> for more details.</p>
|
|
20
|
-
*
|
|
20
|
+
* </note>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
23
|
* ```javascript
|
|
@@ -9,10 +9,10 @@ export interface DeleteGeofenceCollectionCommandOutput extends DeleteGeofenceCol
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a geofence collection from your AWS account.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>This operation deletes the resource permanently. If the geofence collection is the
|
|
14
14
|
* target of a tracker resource, the devices will no longer be monitored.</p>
|
|
15
|
-
*
|
|
15
|
+
* </note>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteMapCommandOutput extends DeleteMapResponse, __MetadataBea
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a map resource from your AWS account.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>This operation deletes the resource permanently. If the map is being used in an application,
|
|
14
14
|
* the map may not render.</p>
|
|
15
15
|
* </note>
|
|
@@ -9,9 +9,9 @@ export interface DeletePlaceIndexCommandOutput extends DeletePlaceIndexResponse,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a place index resource from your AWS account.</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
|
|
@@ -9,9 +9,9 @@ export interface DeleteRouteCalculatorCommandOutput extends DeleteRouteCalculato
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a route calculator resource from your AWS account.</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
|
|
@@ -9,10 +9,10 @@ export interface DisassociateTrackerConsumerCommandOutput extends DisassociateTr
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes the association between a tracker resource and a geofence collection.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>Once you unlink a tracker resource from a geofence collection, the tracker
|
|
14
14
|
* positions will no longer be automatically evaluated against geofences.</p>
|
|
15
|
-
*
|
|
15
|
+
* </note>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface GetDevicePositionHistoryCommandOutput extends GetDevicePosition
|
|
|
11
11
|
* <p>Retrieves the device position history from a tracker resource within a specified range
|
|
12
12
|
* of time.</p>
|
|
13
13
|
* <note>
|
|
14
|
-
*
|
|
14
|
+
* <p>Device positions are deleted after 30 days.</p>
|
|
15
15
|
* </note>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface GetMapStyleDescriptorCommandOutput extends GetMapStyleDescripto
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the map style descriptor from a map resource. </p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The style descriptor contains specifications on how features render on a map. For
|
|
13
13
|
* example, what data to display, what order to display the data in, and the style for the
|
|
14
14
|
* data. Style descriptors follow the Mapbox Style Specification.</p>
|
|
15
15
|
* @example
|
|
@@ -11,7 +11,7 @@ export interface GetMapTileCommandOutput extends GetMapTileResponse, __MetadataB
|
|
|
11
11
|
* <p>Retrieves a vector data tile from the map resource. Map tiles are used by clients to
|
|
12
12
|
* render a map. they're addressed using a grid arrangement with an X coordinate, Y
|
|
13
13
|
* coordinate, and Z (zoom) level. </p>
|
|
14
|
-
*
|
|
14
|
+
* <p>The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles
|
|
15
15
|
* both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0)
|
|
16
16
|
* will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).</p>
|
|
17
17
|
* @example
|
|
@@ -10,21 +10,21 @@ export interface GetPlaceCommandOutput extends GetPlaceResponse, __MetadataBeare
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Finds a place by its unique ID. A <code>PlaceId</code> is returned by other search
|
|
12
12
|
* operations.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>A PlaceId is valid only if all of the following are the same in the original
|
|
15
15
|
* search request and the call to <code>GetPlace</code>.</p>
|
|
16
16
|
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* <p>Customer AWS account</p>
|
|
19
|
+
* </li>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
22
|
-
*
|
|
21
|
+
* <p>AWS Region</p>
|
|
22
|
+
* </li>
|
|
23
23
|
* <li>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* <p>Data provider specified in the place index resource</p>
|
|
25
|
+
* </li>
|
|
26
26
|
* </ul>
|
|
27
|
-
*
|
|
27
|
+
* </note>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -11,15 +11,15 @@ export interface SearchPlaceIndexForSuggestionsCommandOutput extends SearchPlace
|
|
|
11
11
|
* <p>Generates suggestions for addresses and points of interest based on partial or
|
|
12
12
|
* misspelled free-form text. This operation is also known as autocomplete, autosuggest, or
|
|
13
13
|
* fuzzy matching.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
15
15
|
* bias your search toward a specific position on the globe.</p>
|
|
16
|
-
*
|
|
16
|
+
* <note>
|
|
17
17
|
* <p>You can search for suggested place names near a specified position by using
|
|
18
18
|
* <code>BiasPosition</code>, or filter results within a bounding box by using
|
|
19
19
|
* <code>FilterBBox</code>. These parameters are mutually exclusive; using both
|
|
20
20
|
* <code>BiasPosition</code> and <code>FilterBBox</code> in the same command
|
|
21
21
|
* returns an error.</p>
|
|
22
|
-
*
|
|
22
|
+
* </note>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -10,14 +10,14 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
|
|
12
12
|
* search for Places or points of interest. </p>
|
|
13
|
-
*
|
|
13
|
+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
14
14
|
* bias your search toward a specific position on the globe.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <p>You can search for places near a given position using <code>BiasPosition</code>,
|
|
17
17
|
* or filter results within a bounding box using <code>FilterBBox</code>. Providing
|
|
18
18
|
* both parameters simultaneously returns an error.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* </note>
|
|
20
|
+
* <p>Search results are returned in order of highest to lowest relevance.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
23
|
* ```javascript
|
|
@@ -10,18 +10,15 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Assigns one or more tags (key-value pairs) to the specified Amazon
|
|
12
12
|
* Location Service resource.</p>
|
|
13
|
-
*
|
|
14
|
-
* <p>Tags can help you organize and categorize your resources.
|
|
13
|
+
* <p>Tags can help you organize and categorize your resources.
|
|
15
14
|
* You can also use them to scope user permissions, by granting a user
|
|
16
15
|
* permission to access or change only resources with certain tag values.</p>
|
|
17
|
-
*
|
|
18
|
-
* <p>You can use the <code>TagResource</code> operation with an Amazon Location Service
|
|
16
|
+
* <p>You can use the <code>TagResource</code> operation with an Amazon Location Service
|
|
19
17
|
* resource that already has tags. If you specify a new tag key for the resource, this tag
|
|
20
18
|
* is appended to the tags already associated with the resource. If you specify a tag key
|
|
21
19
|
* that's already associated with the resource, the new tag value that you specify replaces
|
|
22
20
|
* the previous value for that tag. </p>
|
|
23
|
-
*
|
|
24
|
-
* <p>You can associate up to 50 tags with a resource.</p>
|
|
21
|
+
* <p>You can associate up to 50 tags with a resource.</p>
|
|
25
22
|
* @example
|
|
26
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
24
|
* ```javascript
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|