@aws-sdk/client-geo-places 3.1022.0 → 3.1023.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.
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
4
|
const y = "required", z = "fn", A = "argv", B = "ref", C = "url", D = "properties", E = "headers";
|
|
5
|
-
const a = true, b = "isSet", c = "booleanEquals", d = "error", e = "endpoint", f = "tree", g = "PartitionResult", h = { [y]: true, "default": false, "type": "boolean" }, i = { [y]: false, "type": "string" }, j = { [B]: "Endpoint" }, k = { [z]: c, [A]: [{ [B]: "UseFIPS" }, true] }, l = { [z]: c, [A]: [{ [B]: "UseDualStack" }, true] }, m = {}, n = { [z]: "stringEquals", [A]: [{ [z]: "getAttr", [A]: [{ [B]: g }, "name"] }, "aws"] }, o = { [z]: c, [A]: [{ [B]: "UseFIPS" }, false] }, p = { [z]: c, [A]: [{ [B]: "UseDualStack" }, false] }, q = { [C]: "https://places.geo.{Region}.{PartitionResult#dnsSuffix}
|
|
5
|
+
const a = true, b = "isSet", c = "booleanEquals", d = "error", e = "endpoint", f = "tree", g = "PartitionResult", h = { [y]: true, "default": false, "type": "boolean" }, i = { [y]: false, "type": "string" }, j = { [B]: "Endpoint" }, k = { [z]: c, [A]: [{ [B]: "UseFIPS" }, true] }, l = { [z]: c, [A]: [{ [B]: "UseDualStack" }, true] }, m = {}, n = { [z]: "stringEquals", [A]: [{ [z]: "getAttr", [A]: [{ [B]: g }, "name"] }, "aws"] }, o = { [z]: c, [A]: [{ [B]: "UseFIPS" }, false] }, p = { [z]: c, [A]: [{ [B]: "UseDualStack" }, false] }, q = { [C]: "https://places.geo.{Region}.{PartitionResult#dnsSuffix}", [D]: {}, [E]: {} }, r = { [C]: "https://places.geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", [D]: {}, [E]: {} }, s = { [C]: "https://places.geo-fips.{Region}.{PartitionResult#dnsSuffix}", [D]: {}, [E]: {} }, t = { [C]: "https://places.geo.{Region}.{PartitionResult#dualStackDnsSuffix}", [D]: {}, [E]: {} }, u = { [z]: "stringEquals", [A]: [{ [z]: "getAttr", [A]: [{ [B]: g }, "name"] }, "aws-us-gov"] }, v = { [z]: "getAttr", [A]: [{ [B]: g }, "supportsFIPS"] }, w = { [z]: c, [A]: [true, { [z]: "getAttr", [A]: [{ [B]: g }, "supportsDualStack"] }] }, x = [{ [B]: "Region" }];
|
|
6
6
|
const _data = { version: "1.0", parameters: { UseDualStack: h, UseFIPS: h, Endpoint: i, Region: i }, rules: [{ conditions: [{ [z]: b, [A]: [j] }], rules: [{ conditions: [k], error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: d }, { rules: [{ conditions: [l], error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: d }, { endpoint: { [C]: j, [D]: m, [E]: m }, type: e }], type: f }], type: f }, { rules: [{ conditions: [{ [z]: b, [A]: x }], rules: [{ conditions: [{ [z]: "aws.partition", [A]: x, assign: g }], rules: [{ conditions: [n, o, p], endpoint: q, type: e }, { conditions: [n, k, l], endpoint: r, type: e }, { conditions: [n, k, p], endpoint: s, type: e }, { conditions: [n, o, l], endpoint: t, type: e }, { conditions: [u, o, p], endpoint: q, type: e }, { conditions: [u, k, l], endpoint: r, type: e }, { conditions: [u, k, p], endpoint: s, type: e }, { conditions: [u, o, l], endpoint: t, type: e }, { conditions: [k, l], rules: [{ conditions: [{ [z]: c, [A]: [a, v] }, w], rules: [{ endpoint: { [C]: "https://geo-places-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", [D]: m, [E]: m }, type: e }], type: f }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: d }], type: f }, { conditions: [k, p], rules: [{ conditions: [{ [z]: c, [A]: [v, a] }], rules: [{ endpoint: { [C]: "https://geo-places-fips.{Region}.{PartitionResult#dnsSuffix}", [D]: m, [E]: m }, type: e }], type: f }, { error: "FIPS is enabled but this partition does not support FIPS", type: d }], type: f }, { conditions: [o, l], rules: [{ conditions: [w], rules: [{ endpoint: { [C]: "https://geo-places.{Region}.{PartitionResult#dualStackDnsSuffix}", [D]: m, [E]: m }, type: e }], type: f }, { error: "DualStack is enabled but this partition does not support DualStack", type: d }], type: f }, { endpoint: { [C]: "https://geo-places.{Region}.{PartitionResult#dnsSuffix}", [D]: m, [E]: m }, type: e }], type: f }], type: f }, { error: "Invalid Configuration: Missing Region", type: d }], type: f }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -819,23 +819,23 @@ var ValidationExceptionFieldList = [1, n0, _VEFL,
|
|
|
819
819
|
0]
|
|
820
820
|
];
|
|
821
821
|
exports.Autocomplete$ = [9, n0, _Au,
|
|
822
|
-
{ [_h]: ["POST", "/autocomplete", 200] }, () => exports.AutocompleteRequest$, () => exports.AutocompleteResponse$
|
|
822
|
+
{ [_h]: ["POST", "/v2/autocomplete", 200] }, () => exports.AutocompleteRequest$, () => exports.AutocompleteResponse$
|
|
823
823
|
];
|
|
824
824
|
exports.Geocode$ = [9, n0, _G,
|
|
825
|
-
{ [_h]: ["POST", "/geocode", 200] }, () => exports.GeocodeRequest$, () => exports.GeocodeResponse$
|
|
825
|
+
{ [_h]: ["POST", "/v2/geocode", 200] }, () => exports.GeocodeRequest$, () => exports.GeocodeResponse$
|
|
826
826
|
];
|
|
827
827
|
exports.GetPlace$ = [9, n0, _GP,
|
|
828
|
-
{ [_h]: ["GET", "/place/{PlaceId}", 200] }, () => exports.GetPlaceRequest$, () => exports.GetPlaceResponse$
|
|
828
|
+
{ [_h]: ["GET", "/v2/place/{PlaceId}", 200] }, () => exports.GetPlaceRequest$, () => exports.GetPlaceResponse$
|
|
829
829
|
];
|
|
830
830
|
exports.ReverseGeocode$ = [9, n0, _RG,
|
|
831
|
-
{ [_h]: ["POST", "/reverse-geocode", 200] }, () => exports.ReverseGeocodeRequest$, () => exports.ReverseGeocodeResponse$
|
|
831
|
+
{ [_h]: ["POST", "/v2/reverse-geocode", 200] }, () => exports.ReverseGeocodeRequest$, () => exports.ReverseGeocodeResponse$
|
|
832
832
|
];
|
|
833
833
|
exports.SearchNearby$ = [9, n0, _SN,
|
|
834
|
-
{ [_h]: ["POST", "/search-nearby", 200] }, () => exports.SearchNearbyRequest$, () => exports.SearchNearbyResponse$
|
|
834
|
+
{ [_h]: ["POST", "/v2/search-nearby", 200] }, () => exports.SearchNearbyRequest$, () => exports.SearchNearbyResponse$
|
|
835
835
|
];
|
|
836
836
|
exports.SearchText$ = [9, n0, _ST,
|
|
837
|
-
{ [_h]: ["POST", "/search-text", 200] }, () => exports.SearchTextRequest$, () => exports.SearchTextResponse$
|
|
837
|
+
{ [_h]: ["POST", "/v2/search-text", 200] }, () => exports.SearchTextRequest$, () => exports.SearchTextResponse$
|
|
838
838
|
];
|
|
839
839
|
exports.Suggest$ = [9, n0, _Sug,
|
|
840
|
-
{ [_h]: ["POST", "/suggest", 200] }, () => exports.SuggestRequest$, () => exports.SuggestResponse$
|
|
840
|
+
{ [_h]: ["POST", "/v2/suggest", 200] }, () => exports.SuggestRequest$, () => exports.SuggestResponse$
|
|
841
841
|
];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
const y = "required", z = "fn", A = "argv", B = "ref", C = "url", D = "properties", E = "headers";
|
|
2
|
-
const a = true, b = "isSet", c = "booleanEquals", d = "error", e = "endpoint", f = "tree", g = "PartitionResult", h = { [y]: true, "default": false, "type": "boolean" }, i = { [y]: false, "type": "string" }, j = { [B]: "Endpoint" }, k = { [z]: c, [A]: [{ [B]: "UseFIPS" }, true] }, l = { [z]: c, [A]: [{ [B]: "UseDualStack" }, true] }, m = {}, n = { [z]: "stringEquals", [A]: [{ [z]: "getAttr", [A]: [{ [B]: g }, "name"] }, "aws"] }, o = { [z]: c, [A]: [{ [B]: "UseFIPS" }, false] }, p = { [z]: c, [A]: [{ [B]: "UseDualStack" }, false] }, q = { [C]: "https://places.geo.{Region}.{PartitionResult#dnsSuffix}
|
|
2
|
+
const a = true, b = "isSet", c = "booleanEquals", d = "error", e = "endpoint", f = "tree", g = "PartitionResult", h = { [y]: true, "default": false, "type": "boolean" }, i = { [y]: false, "type": "string" }, j = { [B]: "Endpoint" }, k = { [z]: c, [A]: [{ [B]: "UseFIPS" }, true] }, l = { [z]: c, [A]: [{ [B]: "UseDualStack" }, true] }, m = {}, n = { [z]: "stringEquals", [A]: [{ [z]: "getAttr", [A]: [{ [B]: g }, "name"] }, "aws"] }, o = { [z]: c, [A]: [{ [B]: "UseFIPS" }, false] }, p = { [z]: c, [A]: [{ [B]: "UseDualStack" }, false] }, q = { [C]: "https://places.geo.{Region}.{PartitionResult#dnsSuffix}", [D]: {}, [E]: {} }, r = { [C]: "https://places.geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", [D]: {}, [E]: {} }, s = { [C]: "https://places.geo-fips.{Region}.{PartitionResult#dnsSuffix}", [D]: {}, [E]: {} }, t = { [C]: "https://places.geo.{Region}.{PartitionResult#dualStackDnsSuffix}", [D]: {}, [E]: {} }, u = { [z]: "stringEquals", [A]: [{ [z]: "getAttr", [A]: [{ [B]: g }, "name"] }, "aws-us-gov"] }, v = { [z]: "getAttr", [A]: [{ [B]: g }, "supportsFIPS"] }, w = { [z]: c, [A]: [true, { [z]: "getAttr", [A]: [{ [B]: g }, "supportsDualStack"] }] }, x = [{ [B]: "Region" }];
|
|
3
3
|
const _data = { version: "1.0", parameters: { UseDualStack: h, UseFIPS: h, Endpoint: i, Region: i }, rules: [{ conditions: [{ [z]: b, [A]: [j] }], rules: [{ conditions: [k], error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: d }, { rules: [{ conditions: [l], error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: d }, { endpoint: { [C]: j, [D]: m, [E]: m }, type: e }], type: f }], type: f }, { rules: [{ conditions: [{ [z]: b, [A]: x }], rules: [{ conditions: [{ [z]: "aws.partition", [A]: x, assign: g }], rules: [{ conditions: [n, o, p], endpoint: q, type: e }, { conditions: [n, k, l], endpoint: r, type: e }, { conditions: [n, k, p], endpoint: s, type: e }, { conditions: [n, o, l], endpoint: t, type: e }, { conditions: [u, o, p], endpoint: q, type: e }, { conditions: [u, k, l], endpoint: r, type: e }, { conditions: [u, k, p], endpoint: s, type: e }, { conditions: [u, o, l], endpoint: t, type: e }, { conditions: [k, l], rules: [{ conditions: [{ [z]: c, [A]: [a, v] }, w], rules: [{ endpoint: { [C]: "https://geo-places-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", [D]: m, [E]: m }, type: e }], type: f }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: d }], type: f }, { conditions: [k, p], rules: [{ conditions: [{ [z]: c, [A]: [v, a] }], rules: [{ endpoint: { [C]: "https://geo-places-fips.{Region}.{PartitionResult#dnsSuffix}", [D]: m, [E]: m }, type: e }], type: f }, { error: "FIPS is enabled but this partition does not support FIPS", type: d }], type: f }, { conditions: [o, l], rules: [{ conditions: [w], rules: [{ endpoint: { [C]: "https://geo-places.{Region}.{PartitionResult#dualStackDnsSuffix}", [D]: m, [E]: m }, type: e }], type: f }, { error: "DualStack is enabled but this partition does not support DualStack", type: d }], type: f }, { endpoint: { [C]: "https://geo-places.{Region}.{PartitionResult#dnsSuffix}", [D]: m, [E]: m }, type: e }], type: f }], type: f }, { error: "Invalid Configuration: Missing Region", type: d }], type: f }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -815,23 +815,23 @@ var ValidationExceptionFieldList = [1, n0, _VEFL,
|
|
|
815
815
|
0]
|
|
816
816
|
];
|
|
817
817
|
export var Autocomplete$ = [9, n0, _Au,
|
|
818
|
-
{ [_h]: ["POST", "/autocomplete", 200] }, () => AutocompleteRequest$, () => AutocompleteResponse$
|
|
818
|
+
{ [_h]: ["POST", "/v2/autocomplete", 200] }, () => AutocompleteRequest$, () => AutocompleteResponse$
|
|
819
819
|
];
|
|
820
820
|
export var Geocode$ = [9, n0, _G,
|
|
821
|
-
{ [_h]: ["POST", "/geocode", 200] }, () => GeocodeRequest$, () => GeocodeResponse$
|
|
821
|
+
{ [_h]: ["POST", "/v2/geocode", 200] }, () => GeocodeRequest$, () => GeocodeResponse$
|
|
822
822
|
];
|
|
823
823
|
export var GetPlace$ = [9, n0, _GP,
|
|
824
|
-
{ [_h]: ["GET", "/place/{PlaceId}", 200] }, () => GetPlaceRequest$, () => GetPlaceResponse$
|
|
824
|
+
{ [_h]: ["GET", "/v2/place/{PlaceId}", 200] }, () => GetPlaceRequest$, () => GetPlaceResponse$
|
|
825
825
|
];
|
|
826
826
|
export var ReverseGeocode$ = [9, n0, _RG,
|
|
827
|
-
{ [_h]: ["POST", "/reverse-geocode", 200] }, () => ReverseGeocodeRequest$, () => ReverseGeocodeResponse$
|
|
827
|
+
{ [_h]: ["POST", "/v2/reverse-geocode", 200] }, () => ReverseGeocodeRequest$, () => ReverseGeocodeResponse$
|
|
828
828
|
];
|
|
829
829
|
export var SearchNearby$ = [9, n0, _SN,
|
|
830
|
-
{ [_h]: ["POST", "/search-nearby", 200] }, () => SearchNearbyRequest$, () => SearchNearbyResponse$
|
|
830
|
+
{ [_h]: ["POST", "/v2/search-nearby", 200] }, () => SearchNearbyRequest$, () => SearchNearbyResponse$
|
|
831
831
|
];
|
|
832
832
|
export var SearchText$ = [9, n0, _ST,
|
|
833
|
-
{ [_h]: ["POST", "/search-text", 200] }, () => SearchTextRequest$, () => SearchTextResponse$
|
|
833
|
+
{ [_h]: ["POST", "/v2/search-text", 200] }, () => SearchTextRequest$, () => SearchTextResponse$
|
|
834
834
|
];
|
|
835
835
|
export var Suggest$ = [9, n0, _Sug,
|
|
836
|
-
{ [_h]: ["POST", "/suggest", 200] }, () => SuggestRequest$, () => SuggestResponse$
|
|
836
|
+
{ [_h]: ["POST", "/v2/suggest", 200] }, () => SuggestRequest$, () => SuggestResponse$
|
|
837
837
|
];
|
|
@@ -79,7 +79,7 @@ export interface Country {
|
|
|
79
79
|
*/
|
|
80
80
|
export interface Region {
|
|
81
81
|
/**
|
|
82
|
-
* <p>Abbreviated code for a the state, province or region of the country. </p> <p>Example: <code>BC</code>.</p>
|
|
82
|
+
* <p> Abbreviated code for a the state, province or region of the country. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: <code>BC</code>.</p>
|
|
83
83
|
* @public
|
|
84
84
|
*/
|
|
85
85
|
Code?: string | undefined;
|
|
@@ -157,7 +157,7 @@ export interface StreetComponents {
|
|
|
157
157
|
*/
|
|
158
158
|
export interface SubRegion {
|
|
159
159
|
/**
|
|
160
|
-
* <p>Abbreviated code for the county or sub-region
|
|
160
|
+
* <p> Abbreviated code for the county or sub-region. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
161
161
|
* @public
|
|
162
162
|
*/
|
|
163
163
|
Code?: string | undefined;
|
|
@@ -213,17 +213,17 @@ export interface Address {
|
|
|
213
213
|
*/
|
|
214
214
|
PostalCode?: string | undefined;
|
|
215
215
|
/**
|
|
216
|
-
* <p>Name of the block. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>
|
|
216
|
+
* <p> Name of the block. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>
|
|
217
217
|
* @public
|
|
218
218
|
*/
|
|
219
219
|
Block?: string | undefined;
|
|
220
220
|
/**
|
|
221
|
-
* <p>Name of sub-block. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>
|
|
221
|
+
* <p> Name of sub-block. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>
|
|
222
222
|
* @public
|
|
223
223
|
*/
|
|
224
224
|
SubBlock?: string | undefined;
|
|
225
225
|
/**
|
|
226
|
-
* <p>Name of the streets in the intersection. </p> <p>Example: <code>["Friedrichstraße","Unter den Linden"]</code> </p>
|
|
226
|
+
* <p> Name of the streets in the intersection. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: <code>["Friedrichstraße","Unter den Linden"]</code> </p>
|
|
227
227
|
* @public
|
|
228
228
|
*/
|
|
229
229
|
Intersection?: string[] | undefined;
|
|
@@ -233,7 +233,7 @@ export interface Address {
|
|
|
233
233
|
*/
|
|
234
234
|
Street?: string | undefined;
|
|
235
235
|
/**
|
|
236
|
-
* <p>Components of the street. </p> <p>Example:
|
|
236
|
+
* <p> Components of the street. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Example: Yonge from "Yonge street".</p>
|
|
237
237
|
* @public
|
|
238
238
|
*/
|
|
239
239
|
StreetComponents?: StreetComponents[] | undefined;
|
|
@@ -243,12 +243,12 @@ export interface Address {
|
|
|
243
243
|
*/
|
|
244
244
|
AddressNumber?: string | undefined;
|
|
245
245
|
/**
|
|
246
|
-
* <p>The name of the building at the address
|
|
246
|
+
* <p> The name of the building at the address. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
247
247
|
* @public
|
|
248
248
|
*/
|
|
249
249
|
Building?: string | undefined;
|
|
250
250
|
/**
|
|
251
|
-
* <p>Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor
|
|
251
|
+
* <p> Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>Coverage for <code>Address.SecondaryAddressComponents</code> is available in the following countries:</p> <p>AUS, CAN, NZL, USA, PRI</p> </note>
|
|
252
252
|
* @public
|
|
253
253
|
*/
|
|
254
254
|
SecondaryAddressComponents?: SecondaryAddressComponent[] | undefined;
|
|
@@ -418,7 +418,7 @@ export interface FilterCircle {
|
|
|
418
418
|
*/
|
|
419
419
|
Center: number[] | undefined;
|
|
420
420
|
/**
|
|
421
|
-
* <p>The radius, in meters, of the <code>FilterCircle</code
|
|
421
|
+
* <p> The radius, in meters, of the <code>FilterCircle</code>. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers,<code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only up to a maximum value of 300,000. </p>
|
|
422
422
|
* @public
|
|
423
423
|
*/
|
|
424
424
|
Radius: number | undefined;
|
|
@@ -494,7 +494,7 @@ export interface AutocompleteRequest {
|
|
|
494
494
|
*/
|
|
495
495
|
PoliticalView?: string | undefined;
|
|
496
496
|
/**
|
|
497
|
-
* <p>Indicates if the results will be
|
|
497
|
+
* <p> Indicates if the query results will be persisted in customer infrastructure. Defaults to <code>SingleUse</code> (not stored). Currently, <code>Autocomplete</code> does not support storage of results. </p>
|
|
498
498
|
* @public
|
|
499
499
|
*/
|
|
500
500
|
IntendedUse?: AutocompleteIntendedUse | undefined;
|
|
@@ -949,7 +949,7 @@ export interface GeocodeRequest {
|
|
|
949
949
|
*/
|
|
950
950
|
PoliticalView?: string | undefined;
|
|
951
951
|
/**
|
|
952
|
-
* <p>Indicates if the results will be
|
|
952
|
+
* <p> Indicates if the query results will be persisted in customer infrastructure. Defaults to <code>SingleUse</code> (not stored). Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>When storing <code>Geocode</code> responses, you <i>must</i> set this field to <code>Storage</code> to comply with the terms of service. These requests will be charged at a higher rate. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
|
|
953
953
|
* @public
|
|
954
954
|
*/
|
|
955
955
|
IntendedUse?: GeocodeIntendedUse | undefined;
|
|
@@ -1401,22 +1401,22 @@ export interface GetPlaceRequest {
|
|
|
1401
1401
|
*/
|
|
1402
1402
|
PlaceId: string | undefined;
|
|
1403
1403
|
/**
|
|
1404
|
-
* <p>A list of optional additional parameters such as time zone that can be requested for each result
|
|
1404
|
+
* <p> A list of optional additional parameters such as time zone that can be requested for each result. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the <code>TimeZone</code> value. </p>
|
|
1405
1405
|
* @public
|
|
1406
1406
|
*/
|
|
1407
1407
|
AdditionalFeatures?: GetPlaceAdditionalFeature[] | undefined;
|
|
1408
1408
|
/**
|
|
1409
|
-
* <p>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry
|
|
1409
|
+
* <p> A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the following codes: <code>en, id, km, lo, ms, my, pt, th, tl, vi, zh</code> </p>
|
|
1410
1410
|
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
Language?: string | undefined;
|
|
1413
1413
|
/**
|
|
1414
|
-
* <p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country
|
|
1414
|
+
* <p> The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1415
1415
|
* @public
|
|
1416
1416
|
*/
|
|
1417
1417
|
PoliticalView?: string | undefined;
|
|
1418
1418
|
/**
|
|
1419
|
-
* <p>Indicates if the results will be
|
|
1419
|
+
* <p> Indicates if the query results will be persisted in customer infrastructure. Defaults to <code>SingleUse</code> (not stored). Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>When storing <code>GetPlace</code> responses, you <i>must</i> set this field to <code>Storage</code> to comply with the terms of service. These requests will be charged at a higher rate. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
|
|
1420
1420
|
* @public
|
|
1421
1421
|
*/
|
|
1422
1422
|
IntendedUse?: GetPlaceIntendedUse | undefined;
|
|
@@ -1519,12 +1519,12 @@ export interface GetPlaceResponse {
|
|
|
1519
1519
|
*/
|
|
1520
1520
|
Address?: Address | undefined;
|
|
1521
1521
|
/**
|
|
1522
|
-
* <p>Boolean indicating if the address provided has been corrected
|
|
1522
|
+
* <p> Boolean indicating if the address provided has been corrected. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1523
1523
|
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
AddressNumberCorrected?: boolean | undefined;
|
|
1526
1526
|
/**
|
|
1527
|
-
* <p>Contains details about the postal code of the place/result. </p>
|
|
1527
|
+
* <p> Contains details about the postal code of the place/result. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1528
1528
|
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
PostalCodeDetails?: PostalCodeDetails[] | undefined;
|
|
@@ -1544,7 +1544,7 @@ export interface GetPlaceResponse {
|
|
|
1544
1544
|
*/
|
|
1545
1545
|
Categories?: Category[] | undefined;
|
|
1546
1546
|
/**
|
|
1547
|
-
* <p>List of food types offered by this result
|
|
1547
|
+
* <p> List of food types offered by this result. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1548
1548
|
* @public
|
|
1549
1549
|
*/
|
|
1550
1550
|
FoodTypes?: FoodType[] | undefined;
|
|
@@ -1554,22 +1554,22 @@ export interface GetPlaceResponse {
|
|
|
1554
1554
|
*/
|
|
1555
1555
|
BusinessChains?: BusinessChain[] | undefined;
|
|
1556
1556
|
/**
|
|
1557
|
-
* <p>List of potential contact methods for the result/place
|
|
1557
|
+
* <p> List of potential contact methods for the result/place. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1558
1558
|
* @public
|
|
1559
1559
|
*/
|
|
1560
1560
|
Contacts?: Contacts | undefined;
|
|
1561
1561
|
/**
|
|
1562
|
-
* <p>List of opening hours objects
|
|
1562
|
+
* <p> List of opening hours objects. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1563
1563
|
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
OpeningHours?: OpeningHours[] | undefined;
|
|
1566
1566
|
/**
|
|
1567
|
-
* <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]
|
|
1567
|
+
* <p> Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1568
1568
|
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
AccessPoints?: AccessPoint[] | undefined;
|
|
1571
1571
|
/**
|
|
1572
|
-
* <p>Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction
|
|
1572
|
+
* <p> Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1573
1573
|
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
AccessRestrictions?: AccessRestriction[] | undefined;
|
|
@@ -1579,22 +1579,22 @@ export interface GetPlaceResponse {
|
|
|
1579
1579
|
*/
|
|
1580
1580
|
TimeZone?: TimeZone | undefined;
|
|
1581
1581
|
/**
|
|
1582
|
-
* <p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country
|
|
1582
|
+
* <p> The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1583
1583
|
* @public
|
|
1584
1584
|
*/
|
|
1585
1585
|
PoliticalView?: string | undefined;
|
|
1586
1586
|
/**
|
|
1587
|
-
* <p>How the various components of the result's address are pronounced in various languages
|
|
1587
|
+
* <p> How the various components of the result's address are pronounced in various languages. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1588
1588
|
* @public
|
|
1589
1589
|
*/
|
|
1590
1590
|
Phonemes?: PhonemeDetails | undefined;
|
|
1591
1591
|
/**
|
|
1592
|
-
* <p>The main address corresponding to a place of type Secondary Address
|
|
1592
|
+
* <p> The main address corresponding to a place of type Secondary Address. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1593
1593
|
* @public
|
|
1594
1594
|
*/
|
|
1595
1595
|
MainAddress?: RelatedPlace | undefined;
|
|
1596
1596
|
/**
|
|
1597
|
-
* <p>All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information
|
|
1597
|
+
* <p> All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.</p> </note>
|
|
1598
1598
|
* @public
|
|
1599
1599
|
*/
|
|
1600
1600
|
SecondaryAddresses?: RelatedPlace[] | undefined;
|
|
@@ -1605,7 +1605,7 @@ export interface GetPlaceResponse {
|
|
|
1605
1605
|
*/
|
|
1606
1606
|
export interface ReverseGeocodeFilter {
|
|
1607
1607
|
/**
|
|
1608
|
-
* <p>The included place types
|
|
1608
|
+
* <p> The included place types. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>Street</code> and <code>PointAddress</code> values. </p>
|
|
1609
1609
|
* @public
|
|
1610
1610
|
*/
|
|
1611
1611
|
IncludePlaceTypes?: ReverseGeocodeFilterPlaceType[] | undefined;
|
|
@@ -1620,12 +1620,12 @@ export interface ReverseGeocodeRequest {
|
|
|
1620
1620
|
*/
|
|
1621
1621
|
QueryPosition: number[] | undefined;
|
|
1622
1622
|
/**
|
|
1623
|
-
* <p>The maximum distance in meters from the QueryPosition from which a result will be returned
|
|
1623
|
+
* <p> The maximum distance in meters from the QueryPosition from which a result will be returned. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only up to a maximum value of 100,000. </p>
|
|
1624
1624
|
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
QueryRadius?: number | undefined;
|
|
1627
1627
|
/**
|
|
1628
|
-
* <p>An optional limit for the number of results returned in a single call.</p> <p>Default value: 1</p>
|
|
1628
|
+
* <p> An optional limit for the number of results returned in a single call.</p> <p>Default value: 1</p>
|
|
1629
1629
|
* @public
|
|
1630
1630
|
*/
|
|
1631
1631
|
MaxResults?: number | undefined;
|
|
@@ -1635,22 +1635,22 @@ export interface ReverseGeocodeRequest {
|
|
|
1635
1635
|
*/
|
|
1636
1636
|
Filter?: ReverseGeocodeFilter | undefined;
|
|
1637
1637
|
/**
|
|
1638
|
-
* <p>A list of optional additional parameters, such as time zone that can be requested for each result
|
|
1638
|
+
* <p> A list of optional additional parameters, such as time zone that can be requested for each result. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the <code>TimeZone</code> value. </p>
|
|
1639
1639
|
* @public
|
|
1640
1640
|
*/
|
|
1641
1641
|
AdditionalFeatures?: ReverseGeocodeAdditionalFeature[] | undefined;
|
|
1642
1642
|
/**
|
|
1643
|
-
* <p>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry
|
|
1643
|
+
* <p> A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the following codes: <code>en, id, km, lo, ms, my, pt, th, tl, vi, zh</code> </p>
|
|
1644
1644
|
* @public
|
|
1645
1645
|
*/
|
|
1646
1646
|
Language?: string | undefined;
|
|
1647
1647
|
/**
|
|
1648
|
-
* <p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country
|
|
1648
|
+
* <p> The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1649
1649
|
* @public
|
|
1650
1650
|
*/
|
|
1651
1651
|
PoliticalView?: string | undefined;
|
|
1652
1652
|
/**
|
|
1653
|
-
* <p>Indicates if the results will be
|
|
1653
|
+
* <p> Indicates if the query results will be persisted in customer infrastructure. Defaults to <code>SingleUse</code> (not stored). </p> <note> <p>When storing <code>ReverseGeocode</code> responses, you <i>must</i> set this field to <code>Storage</code> to comply with the terms of service. These requests will be charged at a higher rate. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
|
|
1654
1654
|
* @public
|
|
1655
1655
|
*/
|
|
1656
1656
|
IntendedUse?: ReverseGeocodeIntendedUse | undefined;
|
|
@@ -1691,12 +1691,12 @@ export interface ReverseGeocodeResultItem {
|
|
|
1691
1691
|
*/
|
|
1692
1692
|
Address?: Address | undefined;
|
|
1693
1693
|
/**
|
|
1694
|
-
* <p>Boolean indicating if the address provided has been corrected
|
|
1694
|
+
* <p> Boolean indicating if the address provided has been corrected. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1695
1695
|
* @public
|
|
1696
1696
|
*/
|
|
1697
1697
|
AddressNumberCorrected?: boolean | undefined;
|
|
1698
1698
|
/**
|
|
1699
|
-
* <p>Contains details about the postal code of the place/result. </p>
|
|
1699
|
+
* <p> Contains details about the postal code of the place/result. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1700
1700
|
* @public
|
|
1701
1701
|
*/
|
|
1702
1702
|
PostalCodeDetails?: PostalCodeDetails[] | undefined;
|
|
@@ -1721,12 +1721,12 @@ export interface ReverseGeocodeResultItem {
|
|
|
1721
1721
|
*/
|
|
1722
1722
|
Categories?: Category[] | undefined;
|
|
1723
1723
|
/**
|
|
1724
|
-
* <p>List of food types offered by this result
|
|
1724
|
+
* <p> List of food types offered by this result. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1725
1725
|
* @public
|
|
1726
1726
|
*/
|
|
1727
1727
|
FoodTypes?: FoodType[] | undefined;
|
|
1728
1728
|
/**
|
|
1729
|
-
* <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]
|
|
1729
|
+
* <p> Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1730
1730
|
* @public
|
|
1731
1731
|
*/
|
|
1732
1732
|
AccessPoints?: AccessPoint[] | undefined;
|
|
@@ -1736,12 +1736,12 @@ export interface ReverseGeocodeResultItem {
|
|
|
1736
1736
|
*/
|
|
1737
1737
|
TimeZone?: TimeZone | undefined;
|
|
1738
1738
|
/**
|
|
1739
|
-
* <p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country
|
|
1739
|
+
* <p> The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1740
1740
|
* @public
|
|
1741
1741
|
*/
|
|
1742
1742
|
PoliticalView?: string | undefined;
|
|
1743
1743
|
/**
|
|
1744
|
-
* <p>All Intersections that are near the provided address
|
|
1744
|
+
* <p> All Intersections that are near the provided address. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1745
1745
|
* @public
|
|
1746
1746
|
*/
|
|
1747
1747
|
Intersections?: Intersection[] | undefined;
|
|
@@ -1847,7 +1847,7 @@ export interface SearchNearbyRequest {
|
|
|
1847
1847
|
*/
|
|
1848
1848
|
PoliticalView?: string | undefined;
|
|
1849
1849
|
/**
|
|
1850
|
-
* <p>Indicates if the results will be
|
|
1850
|
+
* <p> Indicates if the query results will be persisted in customer infrastructure. Defaults to <code>SingleUse</code> (not stored). Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>When storing <code>SearchNearby</code> responses, you <i>must</i> set this field to <code>Storage</code> to comply with the terms of service. These requests will be charged at a higher rate. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
|
|
1851
1851
|
* @public
|
|
1852
1852
|
*/
|
|
1853
1853
|
IntendedUse?: SearchNearbyIntendedUse | undefined;
|
|
@@ -2009,7 +2009,7 @@ export interface SearchTextRequest {
|
|
|
2009
2009
|
*/
|
|
2010
2010
|
QueryText?: string | undefined;
|
|
2011
2011
|
/**
|
|
2012
|
-
* <p>The query Id returned by the suggest API. If passed in the request, the SearchText API will preform a SearchText query with the improved query terms for the original query made to the suggest API.</p> <note> <p>Exactly one of the following fields must be set: <code>QueryText</code> or <code>QueryId</code>.</p> </note>
|
|
2012
|
+
* <p>The query Id returned by the suggest API. If passed in the request, the SearchText API will preform a SearchText query with the improved query terms for the original query made to the suggest API. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p> <note> <p>Exactly one of the following fields must be set: <code>QueryText</code> or <code>QueryId</code>.</p> </note>
|
|
2013
2013
|
* @public
|
|
2014
2014
|
*/
|
|
2015
2015
|
QueryId?: string | undefined;
|
|
@@ -2029,22 +2029,22 @@ export interface SearchTextRequest {
|
|
|
2029
2029
|
*/
|
|
2030
2030
|
Filter?: SearchTextFilter | undefined;
|
|
2031
2031
|
/**
|
|
2032
|
-
* <p>A list of optional additional parameters, such as time zone, that can be requested for each result.</p>
|
|
2032
|
+
* <p>A list of optional additional parameters, such as time zone, that can be requested for each result. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the <code>TimeZone</code> value.</p>
|
|
2033
2033
|
* @public
|
|
2034
2034
|
*/
|
|
2035
2035
|
AdditionalFeatures?: SearchTextAdditionalFeature[] | undefined;
|
|
2036
2036
|
/**
|
|
2037
|
-
* <p>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry
|
|
2037
|
+
* <p>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the following codes: <code>en, id, km, lo, ms, my, pt, th, tl, vi, zh</code> </p>
|
|
2038
2038
|
* @public
|
|
2039
2039
|
*/
|
|
2040
2040
|
Language?: string | undefined;
|
|
2041
2041
|
/**
|
|
2042
|
-
* <p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.</p>
|
|
2042
|
+
* <p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p>
|
|
2043
2043
|
* @public
|
|
2044
2044
|
*/
|
|
2045
2045
|
PoliticalView?: string | undefined;
|
|
2046
2046
|
/**
|
|
2047
|
-
* <p>Indicates if the results will be
|
|
2047
|
+
* <p> Indicates if the query results will be persisted in customer infrastructure. Defaults to <code>SingleUse</code> (not stored). </p> <note> <p>When storing <code>SearchText</code> responses, you <i>must</i> set this field to <code>Storage</code> to comply with the terms of service. These requests will be charged at a higher rate. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
|
|
2048
2048
|
* @public
|
|
2049
2049
|
*/
|
|
2050
2050
|
IntendedUse?: SearchTextIntendedUse | undefined;
|
|
@@ -2206,12 +2206,12 @@ export interface SuggestRequest {
|
|
|
2206
2206
|
*/
|
|
2207
2207
|
QueryText: string | undefined;
|
|
2208
2208
|
/**
|
|
2209
|
-
* <p>An optional limit for the number of results returned in a single call
|
|
2209
|
+
* <p> An optional limit for the number of results returned in a single call. </p> <p>Default value: 20</p>
|
|
2210
2210
|
* @public
|
|
2211
2211
|
*/
|
|
2212
2212
|
MaxResults?: number | undefined;
|
|
2213
2213
|
/**
|
|
2214
|
-
* <p>Maximum number of query terms to be returned for use with a search text query
|
|
2214
|
+
* <p> Maximum number of query terms to be returned for use with a search text query. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2215
2215
|
* @public
|
|
2216
2216
|
*/
|
|
2217
2217
|
MaxQueryRefinements?: number | undefined;
|
|
@@ -2226,22 +2226,22 @@ export interface SuggestRequest {
|
|
|
2226
2226
|
*/
|
|
2227
2227
|
Filter?: SuggestFilter | undefined;
|
|
2228
2228
|
/**
|
|
2229
|
-
* <p>A list of optional additional parameters, such as time zone, that can be requested for each result
|
|
2229
|
+
* <p> A list of optional additional parameters, such as time zone, that can be requested for each result. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the <code>Core</code> and <code>TimeZone</code> values. </p>
|
|
2230
2230
|
* @public
|
|
2231
2231
|
*/
|
|
2232
2232
|
AdditionalFeatures?: SuggestAdditionalFeature[] | undefined;
|
|
2233
2233
|
/**
|
|
2234
|
-
* <p>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry
|
|
2234
|
+
* <p> A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the following codes: <code>en, id, km, lo, ms, my, pt, th, tl, vi, zh</code> </p>
|
|
2235
2235
|
* @public
|
|
2236
2236
|
*/
|
|
2237
2237
|
Language?: string | undefined;
|
|
2238
2238
|
/**
|
|
2239
|
-
* <p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country
|
|
2239
|
+
* <p> The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2240
2240
|
* @public
|
|
2241
2241
|
*/
|
|
2242
2242
|
PoliticalView?: string | undefined;
|
|
2243
2243
|
/**
|
|
2244
|
-
* <p>Indicates if the results will be
|
|
2244
|
+
* <p> Indicates if the query results will be persisted in customer infrastructure. Defaults to <code>SingleUse</code> (not stored). Currently, <code>Suggest</code> does not support storage of results. </p>
|
|
2245
2245
|
* @public
|
|
2246
2246
|
*/
|
|
2247
2247
|
IntendedUse?: SuggestIntendedUse | undefined;
|
|
@@ -2345,22 +2345,22 @@ export interface SuggestPlaceResult {
|
|
|
2345
2345
|
*/
|
|
2346
2346
|
Categories?: Category[] | undefined;
|
|
2347
2347
|
/**
|
|
2348
|
-
* <p>List of food types offered by this result
|
|
2348
|
+
* <p> List of food types offered by this result. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2349
2349
|
* @public
|
|
2350
2350
|
*/
|
|
2351
2351
|
FoodTypes?: FoodType[] | undefined;
|
|
2352
2352
|
/**
|
|
2353
|
-
* <p>The Business Chains associated with the place
|
|
2353
|
+
* <p> The Business Chains associated with the place. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2354
2354
|
* @public
|
|
2355
2355
|
*/
|
|
2356
2356
|
BusinessChains?: BusinessChain[] | undefined;
|
|
2357
2357
|
/**
|
|
2358
|
-
* <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]
|
|
2358
|
+
* <p> Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2359
2359
|
* @public
|
|
2360
2360
|
*/
|
|
2361
2361
|
AccessPoints?: AccessPoint[] | undefined;
|
|
2362
2362
|
/**
|
|
2363
|
-
* <p>Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction
|
|
2363
|
+
* <p> Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2364
2364
|
* @public
|
|
2365
2365
|
*/
|
|
2366
2366
|
AccessRestrictions?: AccessRestriction[] | undefined;
|
|
@@ -2370,12 +2370,12 @@ export interface SuggestPlaceResult {
|
|
|
2370
2370
|
*/
|
|
2371
2371
|
TimeZone?: TimeZone | undefined;
|
|
2372
2372
|
/**
|
|
2373
|
-
* <p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country
|
|
2373
|
+
* <p> The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2374
2374
|
* @public
|
|
2375
2375
|
*/
|
|
2376
2376
|
PoliticalView?: string | undefined;
|
|
2377
2377
|
/**
|
|
2378
|
-
* <p>How the various components of the result's address are pronounced in various languages
|
|
2378
|
+
* <p> How the various components of the result's address are pronounced in various languages. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2379
2379
|
* @public
|
|
2380
2380
|
*/
|
|
2381
2381
|
Phonemes?: PhonemeDetails | undefined;
|
|
@@ -2386,12 +2386,12 @@ export interface SuggestPlaceResult {
|
|
|
2386
2386
|
*/
|
|
2387
2387
|
export interface SuggestQueryResult {
|
|
2388
2388
|
/**
|
|
2389
|
-
* <p>QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchText.html">SearchText API docs</a
|
|
2389
|
+
* <p>QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchText.html">SearchText API docs</a>. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>
|
|
2390
2390
|
* @public
|
|
2391
2391
|
*/
|
|
2392
2392
|
QueryId?: string | undefined;
|
|
2393
2393
|
/**
|
|
2394
|
-
* <p>The query type. Category queries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business
|
|
2394
|
+
* <p> The query type. Category queries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2395
2395
|
* @public
|
|
2396
2396
|
*/
|
|
2397
2397
|
QueryType?: QueryType | undefined;
|
|
@@ -2442,7 +2442,7 @@ export interface SuggestResponse {
|
|
|
2442
2442
|
*/
|
|
2443
2443
|
ResultItems?: SuggestResultItem[] | undefined;
|
|
2444
2444
|
/**
|
|
2445
|
-
* <p>Maximum number of query terms to be returned for use with a search text query
|
|
2445
|
+
* <p> Maximum number of query terms to be returned for use with a search text query. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2446
2446
|
* @public
|
|
2447
2447
|
*/
|
|
2448
2448
|
QueryRefinements?: QueryRefinement[] | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-geo-places",
|
|
3
3
|
"description": "AWS SDK for JavaScript Geo Places Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.1023.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-geo-places",
|