@aws-sdk/client-geo-maps 3.683.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.
Files changed (99) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +273 -0
  3. package/dist-cjs/GeoMaps.js +21 -0
  4. package/dist-cjs/GeoMapsClient.js +50 -0
  5. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  6. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  7. package/dist-cjs/commands/GetGlyphsCommand.js +26 -0
  8. package/dist-cjs/commands/GetSpritesCommand.js +26 -0
  9. package/dist-cjs/commands/GetStaticMapCommand.js +27 -0
  10. package/dist-cjs/commands/GetStyleDescriptorCommand.js +27 -0
  11. package/dist-cjs/commands/GetTileCommand.js +27 -0
  12. package/dist-cjs/commands/index.js +8 -0
  13. package/dist-cjs/endpoint/EndpointParameters.js +18 -0
  14. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  15. package/dist-cjs/endpoint/ruleset.js +7 -0
  16. package/dist-cjs/extensionConfiguration.js +2 -0
  17. package/dist-cjs/index.js +10 -0
  18. package/dist-cjs/models/GeoMapsServiceException.js +12 -0
  19. package/dist-cjs/models/index.js +4 -0
  20. package/dist-cjs/models/models_0.js +110 -0
  21. package/dist-cjs/protocols/Aws_restJson1.js +307 -0
  22. package/dist-cjs/runtimeConfig.browser.js +39 -0
  23. package/dist-cjs/runtimeConfig.js +50 -0
  24. package/dist-cjs/runtimeConfig.native.js +15 -0
  25. package/dist-cjs/runtimeConfig.shared.js +34 -0
  26. package/dist-cjs/runtimeExtensions.js +25 -0
  27. package/dist-es/GeoMaps.js +17 -0
  28. package/dist-es/GeoMapsClient.js +46 -0
  29. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  30. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  31. package/dist-es/commands/GetGlyphsCommand.js +22 -0
  32. package/dist-es/commands/GetSpritesCommand.js +22 -0
  33. package/dist-es/commands/GetStaticMapCommand.js +23 -0
  34. package/dist-es/commands/GetStyleDescriptorCommand.js +23 -0
  35. package/dist-es/commands/GetTileCommand.js +23 -0
  36. package/dist-es/commands/index.js +5 -0
  37. package/dist-es/endpoint/EndpointParameters.js +14 -0
  38. package/dist-es/endpoint/endpointResolver.js +14 -0
  39. package/dist-es/endpoint/ruleset.js +4 -0
  40. package/dist-es/extensionConfiguration.js +1 -0
  41. package/dist-es/index.js +5 -0
  42. package/dist-es/models/GeoMapsServiceException.js +8 -0
  43. package/dist-es/models/index.js +1 -0
  44. package/dist-es/models/models_0.js +100 -0
  45. package/dist-es/protocols/Aws_restJson1.js +294 -0
  46. package/dist-es/runtimeConfig.browser.js +34 -0
  47. package/dist-es/runtimeConfig.js +45 -0
  48. package/dist-es/runtimeConfig.native.js +11 -0
  49. package/dist-es/runtimeConfig.shared.js +30 -0
  50. package/dist-es/runtimeExtensions.js +21 -0
  51. package/dist-types/GeoMaps.d.ts +73 -0
  52. package/dist-types/GeoMapsClient.d.ts +202 -0
  53. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  54. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  55. package/dist-types/commands/GetGlyphsCommand.d.ts +82 -0
  56. package/dist-types/commands/GetSpritesCommand.d.ts +84 -0
  57. package/dist-types/commands/GetStaticMapCommand.d.ts +107 -0
  58. package/dist-types/commands/GetStyleDescriptorCommand.d.ts +84 -0
  59. package/dist-types/commands/GetTileCommand.d.ts +98 -0
  60. package/dist-types/commands/index.d.ts +5 -0
  61. package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
  62. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  63. package/dist-types/endpoint/ruleset.d.ts +2 -0
  64. package/dist-types/extensionConfiguration.d.ts +9 -0
  65. package/dist-types/index.d.ts +41 -0
  66. package/dist-types/models/GeoMapsServiceException.d.ts +14 -0
  67. package/dist-types/models/index.d.ts +1 -0
  68. package/dist-types/models/models_0.d.ts +892 -0
  69. package/dist-types/protocols/Aws_restJson1.d.ts +47 -0
  70. package/dist-types/runtimeConfig.browser.d.ts +48 -0
  71. package/dist-types/runtimeConfig.d.ts +48 -0
  72. package/dist-types/runtimeConfig.native.d.ts +47 -0
  73. package/dist-types/runtimeConfig.shared.d.ts +21 -0
  74. package/dist-types/runtimeExtensions.d.ts +17 -0
  75. package/dist-types/ts3.4/GeoMaps.d.ts +90 -0
  76. package/dist-types/ts3.4/GeoMapsClient.d.ts +148 -0
  77. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  78. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  79. package/dist-types/ts3.4/commands/GetGlyphsCommand.d.ts +54 -0
  80. package/dist-types/ts3.4/commands/GetSpritesCommand.d.ts +54 -0
  81. package/dist-types/ts3.4/commands/GetStaticMapCommand.d.ts +54 -0
  82. package/dist-types/ts3.4/commands/GetStyleDescriptorCommand.d.ts +58 -0
  83. package/dist-types/ts3.4/commands/GetTileCommand.d.ts +50 -0
  84. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  85. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  86. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  87. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  88. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  89. package/dist-types/ts3.4/index.d.ts +8 -0
  90. package/dist-types/ts3.4/models/GeoMapsServiceException.d.ts +9 -0
  91. package/dist-types/ts3.4/models/index.d.ts +1 -0
  92. package/dist-types/ts3.4/models/models_0.d.ts +160 -0
  93. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +65 -0
  94. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
  95. package/dist-types/ts3.4/runtimeConfig.d.ts +94 -0
  96. package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
  97. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
  98. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  99. package/package.json +102 -0
@@ -0,0 +1,892 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { GeoMapsServiceException as __BaseException } from "./GeoMapsServiceException";
3
+ /**
4
+ * <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
5
+ * @public
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ Message: string | undefined;
11
+ /**
12
+ * @internal
13
+ */
14
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
+ }
16
+ /**
17
+ * @public
18
+ * @enum
19
+ */
20
+ export declare const ColorScheme: {
21
+ readonly DARK: "Dark";
22
+ readonly LIGHT: "Light";
23
+ };
24
+ /**
25
+ * @public
26
+ */
27
+ export type ColorScheme = (typeof ColorScheme)[keyof typeof ColorScheme];
28
+ /**
29
+ * @public
30
+ */
31
+ export interface GetGlyphsRequest {
32
+ /**
33
+ * <p>Name of the <code>FontStack</code> to retrieve. </p>
34
+ * <p>Example: <code>Amazon Ember Bold,Noto Sans Bold</code>.</p>
35
+ * <p>The supported font stacks are as follows:</p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>Amazon Ember Bold</p>
39
+ * </li>
40
+ * <li>
41
+ * <p>Amazon Ember Bold Italic</p>
42
+ * </li>
43
+ * <li>
44
+ * <p>Amazon Ember Bold,Noto Sans Bold</p>
45
+ * </li>
46
+ * <li>
47
+ * <p>Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold</p>
48
+ * </li>
49
+ * <li>
50
+ * <p>Amazon Ember Condensed RC BdItalic</p>
51
+ * </li>
52
+ * <li>
53
+ * <p>Amazon Ember Condensed RC Bold</p>
54
+ * </li>
55
+ * <li>
56
+ * <p>Amazon Ember Condensed RC Bold Italic</p>
57
+ * </li>
58
+ * <li>
59
+ * <p>Amazon Ember Condensed RC Bold,Noto Sans Bold</p>
60
+ * </li>
61
+ * <li>
62
+ * <p>Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold</p>
63
+ * </li>
64
+ * <li>
65
+ * <p>Amazon Ember Condensed RC Light</p>
66
+ * </li>
67
+ * <li>
68
+ * <p>Amazon Ember Condensed RC Light Italic</p>
69
+ * </li>
70
+ * <li>
71
+ * <p>Amazon Ember Condensed RC LtItalic</p>
72
+ * </li>
73
+ * <li>
74
+ * <p>Amazon Ember Condensed RC Regular</p>
75
+ * </li>
76
+ * <li>
77
+ * <p>Amazon Ember Condensed RC Regular Italic</p>
78
+ * </li>
79
+ * <li>
80
+ * <p>Amazon Ember Condensed RC Regular,Noto Sans Regular</p>
81
+ * </li>
82
+ * <li>
83
+ * <p>Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular</p>
84
+ * </li>
85
+ * <li>
86
+ * <p>Amazon Ember Condensed RC RgItalic</p>
87
+ * </li>
88
+ * <li>
89
+ * <p>Amazon Ember Condensed RC ThItalic</p>
90
+ * </li>
91
+ * <li>
92
+ * <p>Amazon Ember Condensed RC Thin</p>
93
+ * </li>
94
+ * <li>
95
+ * <p>Amazon Ember Condensed RC Thin Italic</p>
96
+ * </li>
97
+ * <li>
98
+ * <p>Amazon Ember Heavy</p>
99
+ * </li>
100
+ * <li>
101
+ * <p>Amazon Ember Heavy Italic</p>
102
+ * </li>
103
+ * <li>
104
+ * <p>Amazon Ember Light</p>
105
+ * </li>
106
+ * <li>
107
+ * <p>Amazon Ember Light Italic</p>
108
+ * </li>
109
+ * <li>
110
+ * <p>Amazon Ember Medium</p>
111
+ * </li>
112
+ * <li>
113
+ * <p>Amazon Ember Medium Italic</p>
114
+ * </li>
115
+ * <li>
116
+ * <p>Amazon Ember Medium,Noto Sans Medium</p>
117
+ * </li>
118
+ * <li>
119
+ * <p>Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium</p>
120
+ * </li>
121
+ * <li>
122
+ * <p>Amazon Ember Regular</p>
123
+ * </li>
124
+ * <li>
125
+ * <p>Amazon Ember Regular Italic</p>
126
+ * </li>
127
+ * <li>
128
+ * <p>Amazon Ember Regular Italic,Noto Sans Italic</p>
129
+ * </li>
130
+ * <li>
131
+ * <p>Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular</p>
132
+ * </li>
133
+ * <li>
134
+ * <p>Amazon Ember Regular,Noto Sans Regular</p>
135
+ * </li>
136
+ * <li>
137
+ * <p>Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular</p>
138
+ * </li>
139
+ * <li>
140
+ * <p>Amazon Ember Thin</p>
141
+ * </li>
142
+ * <li>
143
+ * <p>Amazon Ember Thin Italic</p>
144
+ * </li>
145
+ * <li>
146
+ * <p>AmazonEmberCdRC_Bd</p>
147
+ * </li>
148
+ * <li>
149
+ * <p>AmazonEmberCdRC_BdIt</p>
150
+ * </li>
151
+ * <li>
152
+ * <p>AmazonEmberCdRC_Lt</p>
153
+ * </li>
154
+ * <li>
155
+ * <p>AmazonEmberCdRC_LtIt</p>
156
+ * </li>
157
+ * <li>
158
+ * <p>AmazonEmberCdRC_Rg</p>
159
+ * </li>
160
+ * <li>
161
+ * <p>AmazonEmberCdRC_RgIt</p>
162
+ * </li>
163
+ * <li>
164
+ * <p>AmazonEmberCdRC_Th</p>
165
+ * </li>
166
+ * <li>
167
+ * <p>AmazonEmberCdRC_ThIt</p>
168
+ * </li>
169
+ * <li>
170
+ * <p>AmazonEmber_Bd</p>
171
+ * </li>
172
+ * <li>
173
+ * <p>AmazonEmber_BdIt</p>
174
+ * </li>
175
+ * <li>
176
+ * <p>AmazonEmber_He</p>
177
+ * </li>
178
+ * <li>
179
+ * <p>AmazonEmber_HeIt</p>
180
+ * </li>
181
+ * <li>
182
+ * <p>AmazonEmber_Lt</p>
183
+ * </li>
184
+ * <li>
185
+ * <p>AmazonEmber_LtIt</p>
186
+ * </li>
187
+ * <li>
188
+ * <p>AmazonEmber_Md</p>
189
+ * </li>
190
+ * <li>
191
+ * <p>AmazonEmber_MdIt</p>
192
+ * </li>
193
+ * <li>
194
+ * <p>AmazonEmber_Rg</p>
195
+ * </li>
196
+ * <li>
197
+ * <p>AmazonEmber_RgIt</p>
198
+ * </li>
199
+ * <li>
200
+ * <p>AmazonEmber_Th</p>
201
+ * </li>
202
+ * <li>
203
+ * <p>AmazonEmber_ThIt</p>
204
+ * </li>
205
+ * <li>
206
+ * <p>Noto Sans Black</p>
207
+ * </li>
208
+ * <li>
209
+ * <p>Noto Sans Black Italic</p>
210
+ * </li>
211
+ * <li>
212
+ * <p>Noto Sans Bold</p>
213
+ * </li>
214
+ * <li>
215
+ * <p>Noto Sans Bold Italic</p>
216
+ * </li>
217
+ * <li>
218
+ * <p>Noto Sans Extra Bold</p>
219
+ * </li>
220
+ * <li>
221
+ * <p>Noto Sans Extra Bold Italic</p>
222
+ * </li>
223
+ * <li>
224
+ * <p>Noto Sans Extra Light</p>
225
+ * </li>
226
+ * <li>
227
+ * <p>Noto Sans Extra Light Italic</p>
228
+ * </li>
229
+ * <li>
230
+ * <p>Noto Sans Italic</p>
231
+ * </li>
232
+ * <li>
233
+ * <p>Noto Sans Light</p>
234
+ * </li>
235
+ * <li>
236
+ * <p>Noto Sans Light Italic</p>
237
+ * </li>
238
+ * <li>
239
+ * <p>Noto Sans Medium</p>
240
+ * </li>
241
+ * <li>
242
+ * <p>Noto Sans Medium Italic</p>
243
+ * </li>
244
+ * <li>
245
+ * <p>Noto Sans Regular</p>
246
+ * </li>
247
+ * <li>
248
+ * <p>Noto Sans Semi Bold</p>
249
+ * </li>
250
+ * <li>
251
+ * <p>Noto Sans Semi Bold Italic</p>
252
+ * </li>
253
+ * <li>
254
+ * <p>Noto Sans Thin</p>
255
+ * </li>
256
+ * <li>
257
+ * <p>Noto Sans Thin Italic</p>
258
+ * </li>
259
+ * <li>
260
+ * <p>NotoSans-Bold</p>
261
+ * </li>
262
+ * <li>
263
+ * <p>NotoSans-Italic</p>
264
+ * </li>
265
+ * <li>
266
+ * <p>NotoSans-Medium</p>
267
+ * </li>
268
+ * <li>
269
+ * <p>NotoSans-Regular</p>
270
+ * </li>
271
+ * <li>
272
+ * <p>Open Sans Regular,Arial Unicode MS Regular</p>
273
+ * </li>
274
+ * </ul>
275
+ * @public
276
+ */
277
+ FontStack: string | undefined;
278
+ /**
279
+ * <p>A Unicode range of characters to download glyphs for. This must be aligned to multiples
280
+ * of 256. </p>
281
+ * <p>Example: <code>0-255.pdf</code>
282
+ * </p>
283
+ * @public
284
+ */
285
+ FontUnicodeRange: string | undefined;
286
+ }
287
+ /**
288
+ * @public
289
+ */
290
+ export interface GetGlyphsResponse {
291
+ /**
292
+ * <p>The Glyph, as a binary blob.</p>
293
+ * @public
294
+ */
295
+ Blob?: Uint8Array;
296
+ /**
297
+ * <p>Header that represents the format of the response. The response returns the following as the HTTP body.</p>
298
+ * @public
299
+ */
300
+ ContentType?: string;
301
+ /**
302
+ * <p>Header that instructs caching configuration for the client.</p>
303
+ * @public
304
+ */
305
+ CacheControl?: string;
306
+ /**
307
+ * <p>The glyph's Etag.</p>
308
+ * @public
309
+ */
310
+ ETag?: string;
311
+ }
312
+ /**
313
+ * @public
314
+ * @enum
315
+ */
316
+ export declare const MapStyle: {
317
+ readonly HYBRID: "Hybrid";
318
+ readonly MONOCHROME: "Monochrome";
319
+ readonly SATELLITE: "Satellite";
320
+ readonly STANDARD: "Standard";
321
+ };
322
+ /**
323
+ * @public
324
+ */
325
+ export type MapStyle = (typeof MapStyle)[keyof typeof MapStyle];
326
+ /**
327
+ * @public
328
+ * @enum
329
+ */
330
+ export declare const Variant: {
331
+ readonly DEFAULT: "Default";
332
+ };
333
+ /**
334
+ * @public
335
+ */
336
+ export type Variant = (typeof Variant)[keyof typeof Variant];
337
+ /**
338
+ * @public
339
+ */
340
+ export interface GetSpritesRequest {
341
+ /**
342
+ * <p>
343
+ * <code>Sprites</code> API: The name of the sprite file to retrieve, following pattern
344
+ * <code>sprites(@2x)?\.(png|json)</code>.</p>
345
+ * <p>Example: <code>sprites.png</code>
346
+ * </p>
347
+ * @public
348
+ */
349
+ FileName: string | undefined;
350
+ /**
351
+ * <p>Style specifies the desired map style for the <code>Sprites</code> APIs.</p>
352
+ * @public
353
+ */
354
+ Style: MapStyle | undefined;
355
+ /**
356
+ * <p>Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.</p>
357
+ * <p>Example: <code>Light</code>
358
+ * </p>
359
+ * <p>Default value: <code>Light</code>
360
+ * </p>
361
+ * <note>
362
+ * <p>Valid values for ColorScheme are case sensitive.</p>
363
+ * </note>
364
+ * @public
365
+ */
366
+ ColorScheme: ColorScheme | undefined;
367
+ /**
368
+ * <p>Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.</p>
369
+ * <p>Example: <code>Default</code>
370
+ * </p>
371
+ * <note>
372
+ * <p>Valid values for Variant are case sensitive.</p>
373
+ * </note>
374
+ * @public
375
+ */
376
+ Variant: Variant | undefined;
377
+ }
378
+ /**
379
+ * @public
380
+ */
381
+ export interface GetSpritesResponse {
382
+ /**
383
+ * <p>The body of the sprite sheet or JSON offset file (image/png or application/json,
384
+ * depending on input).</p>
385
+ * @public
386
+ */
387
+ Blob?: Uint8Array;
388
+ /**
389
+ * <p>Header that represents the format of the response. The response returns the following as the HTTP body.</p>
390
+ * @public
391
+ */
392
+ ContentType?: string;
393
+ /**
394
+ * <p>Header that instructs caching configuration for the client.</p>
395
+ * @public
396
+ */
397
+ CacheControl?: string;
398
+ /**
399
+ * <p>The sprite's Etag.</p>
400
+ * @public
401
+ */
402
+ ETag?: string;
403
+ }
404
+ /**
405
+ * @public
406
+ * @enum
407
+ */
408
+ export declare const ScaleBarUnit: {
409
+ readonly KILOMETERS: "Kilometers";
410
+ readonly KILOMETERS_MILES: "KilometersMiles";
411
+ readonly MILES: "Miles";
412
+ readonly MILES_KILOMETERS: "MilesKilometers";
413
+ };
414
+ /**
415
+ * @public
416
+ */
417
+ export type ScaleBarUnit = (typeof ScaleBarUnit)[keyof typeof ScaleBarUnit];
418
+ /**
419
+ * @public
420
+ * @enum
421
+ */
422
+ export declare const StaticMapStyle: {
423
+ readonly SATELLITE: "Satellite";
424
+ };
425
+ /**
426
+ * @public
427
+ */
428
+ export type StaticMapStyle = (typeof StaticMapStyle)[keyof typeof StaticMapStyle];
429
+ /**
430
+ * @public
431
+ */
432
+ export interface GetStaticMapRequest {
433
+ /**
434
+ * <p>Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and
435
+ * north-easterly edges of the image. The underlying area becomes the view of the image. </p>
436
+ * <p>Example: -123.17075,49.26959,-123.08125,49.31429</p>
437
+ * @public
438
+ */
439
+ BoundingBox?: string;
440
+ /**
441
+ * <p>Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by
442
+ * a comma. The API will generate an image to encompass all of the provided coordinates. </p>
443
+ * <note>
444
+ * <p>Cannot be used with <code>Zoom</code> and or <code>Radius</code>
445
+ * </p>
446
+ * </note>
447
+ * <p>Example: 97.170451,78.039098,99.045536,27.176178</p>
448
+ * @public
449
+ */
450
+ BoundedPositions?: string;
451
+ /**
452
+ * <p>Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image.
453
+ * This parameter requires that either zoom or radius is set.</p>
454
+ * <note>
455
+ * <p>Cannot be used with <code>Zoom</code> and or <code>Radius</code>
456
+ * </p>
457
+ * </note>
458
+ * <p>Example: 49.295,-123.108</p>
459
+ * @public
460
+ */
461
+ Center?: string;
462
+ /**
463
+ * <p>Takes in a string to draw geometries on the image. The input is a comma separated format as follows format:
464
+ * <code>[Lon, Lat]</code>
465
+ * </p>
466
+ * <p>Example:
467
+ * <code>line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B</code>
468
+ * </p>
469
+ * <note>
470
+ * <p>Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.</p>
471
+ * </note>
472
+ * @public
473
+ */
474
+ CompactOverlay?: string;
475
+ /**
476
+ * <p>Takes in a string to draw geometries on the image. The input is a valid GeoJSON
477
+ * collection object. </p>
478
+ * <p>Example:
479
+ * <code>\{"type":"FeatureCollection","features": [\{"type":"Feature","geometry":\{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]\},"properties": \{"color":"#00DD00"\}\}]\}</code>
480
+ * </p>
481
+ * @public
482
+ */
483
+ GeoJsonOverlay?: string;
484
+ /**
485
+ * <p>Specifies the height of the map image.</p>
486
+ * @public
487
+ */
488
+ Height: number | undefined;
489
+ /**
490
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4
491
+ * signature must be provided when making a request. </p>
492
+ * @public
493
+ */
494
+ Key?: string;
495
+ /**
496
+ * <p>Applies additional space (in pixels) around overlay feature to prevent them from being
497
+ * cut or obscured.</p>
498
+ * <note>
499
+ * <p>Value for max and min is determined by:</p>
500
+ * <p>Min: <code>1</code>
501
+ * </p>
502
+ * <p>Max: <code>min(height, width)/4</code>
503
+ * </p>
504
+ * </note>
505
+ * <p>Example: <code>100</code>
506
+ * </p>
507
+ * @public
508
+ */
509
+ Padding?: number;
510
+ /**
511
+ * <p>Used with center parameter, it specifies the zoom of the image where you can control it
512
+ * on a granular level. Takes in any value <code>&gt;= 1</code>. </p>
513
+ * <p>Example: <code>1500</code>
514
+ * </p>
515
+ * <note>
516
+ * <p>Cannot be used with <code>Zoom</code>.</p>
517
+ * </note>
518
+ * <p>
519
+ * <b>Unit</b>: <code>Meters</code>
520
+ * </p>
521
+ * <p/>
522
+ * @public
523
+ */
524
+ Radius?: number;
525
+ /**
526
+ * <p>The map scaling parameter to size the image, icons, and labels. It follows the pattern
527
+ * of <code>^map(@2x)?$</code>.</p>
528
+ * <p>Example: <code>map, map@2x</code>
529
+ * </p>
530
+ * @public
531
+ */
532
+ FileName: string | undefined;
533
+ /**
534
+ * <p>Displays a scale on the bottom right of the map image with the unit specified in the
535
+ * input. </p>
536
+ * <p>Example: <code>KilometersMiles, Miles, Kilometers, MilesKilometers</code>
537
+ * </p>
538
+ * @public
539
+ */
540
+ ScaleBarUnit?: ScaleBarUnit;
541
+ /**
542
+ * <p>Style specifies the desired map style for the <code>Style</code> APIs.</p>
543
+ * @public
544
+ */
545
+ Style?: StaticMapStyle;
546
+ /**
547
+ * <p>Specifies the width of the map image.</p>
548
+ * @public
549
+ */
550
+ Width: number | undefined;
551
+ /**
552
+ * <p>Specifies the zoom level of the map image.</p>
553
+ * <note>
554
+ * <p>Cannot be used with <code>Radius</code>.</p>
555
+ * </note>
556
+ * @public
557
+ */
558
+ Zoom?: number;
559
+ }
560
+ /**
561
+ * @public
562
+ */
563
+ export interface GetStaticMapResponse {
564
+ /**
565
+ * <p>The blob represents a map image as a <code>jpeg</code> for
566
+ * the <code>GetStaticMap</code> API.</p>
567
+ * @public
568
+ */
569
+ Blob?: Uint8Array;
570
+ /**
571
+ * <p>Header that represents the format of the response. The response returns the following as the HTTP body.</p>
572
+ * @public
573
+ */
574
+ ContentType?: string;
575
+ /**
576
+ * <p>Header that instructs caching configuration for the client.</p>
577
+ * @public
578
+ */
579
+ CacheControl?: string;
580
+ /**
581
+ * <p>The static map's Etag.</p>
582
+ * @public
583
+ */
584
+ ETag?: string;
585
+ /**
586
+ * <p>The pricing bucket for which the request is charged at.</p>
587
+ * @public
588
+ */
589
+ PricingBucket: string | undefined;
590
+ }
591
+ /**
592
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
593
+ * @public
594
+ */
595
+ export declare class InternalServerException extends __BaseException {
596
+ readonly name: "InternalServerException";
597
+ readonly $fault: "server";
598
+ $retryable: {};
599
+ Message: string | undefined;
600
+ /**
601
+ * @internal
602
+ */
603
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
604
+ }
605
+ /**
606
+ * <p>The request was denied due to request throttling.</p>
607
+ * @public
608
+ */
609
+ export declare class ThrottlingException extends __BaseException {
610
+ readonly name: "ThrottlingException";
611
+ readonly $fault: "client";
612
+ $retryable: {};
613
+ Message: string | undefined;
614
+ /**
615
+ * @internal
616
+ */
617
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
618
+ }
619
+ /**
620
+ * <p>The input fails to satisfy the constraints specified by the Amazon Location service.</p>
621
+ * @public
622
+ */
623
+ export interface ValidationExceptionField {
624
+ /**
625
+ * <p>The name of the resource.</p>
626
+ * @public
627
+ */
628
+ Name: string | undefined;
629
+ /**
630
+ * <p>The error message.</p>
631
+ * @public
632
+ */
633
+ Message: string | undefined;
634
+ }
635
+ /**
636
+ * @public
637
+ * @enum
638
+ */
639
+ export declare const ValidationExceptionReason: {
640
+ /**
641
+ * The input cannot be parsed. For example a required JSON document, ARN identifier,
642
+ * date value, or numeric field cannot be parsed.
643
+ *
644
+ */
645
+ readonly CANNOT_PARSE: "CannotParse";
646
+ /**
647
+ * The input is present and parsable, but it is otherwise invalid. For example, a
648
+ * required numeric argument is outside the allowed range.
649
+ *
650
+ */
651
+ readonly FIELD_VALIDATION_FAILED: "FieldValidationFailed";
652
+ /**
653
+ * The required input is missing.
654
+ */
655
+ readonly MISSING: "Missing";
656
+ /**
657
+ * The input is invalid but no more specific reason is applicable.
658
+ */
659
+ readonly OTHER: "Other";
660
+ /**
661
+ * No such field is supported.
662
+ */
663
+ readonly UNKNOWN_FIELD: "UnknownField";
664
+ /**
665
+ * No such operation is supported.
666
+ */
667
+ readonly UNKNOWN_OPERATION: "UnknownOperation";
668
+ };
669
+ /**
670
+ * @public
671
+ */
672
+ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
673
+ /**
674
+ * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
675
+ * @public
676
+ */
677
+ export declare class ValidationException extends __BaseException {
678
+ readonly name: "ValidationException";
679
+ readonly $fault: "client";
680
+ Message: string | undefined;
681
+ /**
682
+ * <p>The field where thebb invalid entry was detected.</p>
683
+ * @public
684
+ */
685
+ Reason: ValidationExceptionReason | undefined;
686
+ /**
687
+ * <p>A message with the reason for the validation exception error.</p>
688
+ * @public
689
+ */
690
+ FieldList: ValidationExceptionField[] | undefined;
691
+ /**
692
+ * @internal
693
+ */
694
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
695
+ }
696
+ /**
697
+ * @public
698
+ */
699
+ export interface GetStyleDescriptorRequest {
700
+ /**
701
+ * <p>Style specifies the desired map style.</p>
702
+ * @public
703
+ */
704
+ Style: MapStyle | undefined;
705
+ /**
706
+ * <p>Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.</p>
707
+ * <p>Example: <code>Light</code>
708
+ * </p>
709
+ * <p>Default value: <code>Light</code>
710
+ * </p>
711
+ * <note>
712
+ * <p>Valid values for ColorScheme are case sensitive.</p>
713
+ * </note>
714
+ * @public
715
+ */
716
+ ColorScheme?: ColorScheme;
717
+ /**
718
+ * <p>Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.</p>
719
+ * <p>The following political views are currently supported:</p>
720
+ * <ul>
721
+ * <li>
722
+ * <p>
723
+ * <code>ARG</code>: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands</p>
724
+ * </li>
725
+ * <li>
726
+ * <p>
727
+ * <code>EGY</code>: Egypt's view on Bir Tawil</p>
728
+ * </li>
729
+ * <li>
730
+ * <p>
731
+ * <code>IND</code>: India's view on Gilgit-Baltistan</p>
732
+ * </li>
733
+ * <li>
734
+ * <p>
735
+ * <code>KEN</code>: Kenya's view on the Ilemi Triangle</p>
736
+ * </li>
737
+ * <li>
738
+ * <p>
739
+ * <code>MAR</code>: Morocco's view on Western Sahara</p>
740
+ * </li>
741
+ * <li>
742
+ * <p>
743
+ * <code>PAK</code>: Pakistan's view on Jammu and Kashmir and the Junagadh Area</p>
744
+ * </li>
745
+ * <li>
746
+ * <p>
747
+ * <code>RUS</code>: Russia's view on Crimea</p>
748
+ * </li>
749
+ * <li>
750
+ * <p>
751
+ * <code>SDN</code>: Sudan's view on the Halaib Triangle</p>
752
+ * </li>
753
+ * <li>
754
+ * <p>
755
+ * <code>SRB</code>: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands</p>
756
+ * </li>
757
+ * <li>
758
+ * <p>
759
+ * <code>SUR</code>: Suriname's view on the Courantyne Headwaters and Lawa Headwaters</p>
760
+ * </li>
761
+ * <li>
762
+ * <p>
763
+ * <code>SYR</code>: Syria's view on the Golan Heights</p>
764
+ * </li>
765
+ * <li>
766
+ * <p>
767
+ * <code>TUR</code>: Turkey's view on Cyprus and Northern Cyprus</p>
768
+ * </li>
769
+ * <li>
770
+ * <p>
771
+ * <code>TZA</code>: Tanzania's view on Lake Malawi</p>
772
+ * </li>
773
+ * <li>
774
+ * <p>
775
+ * <code>URY</code>: Uruguay's view on Rincon de Artigas</p>
776
+ * </li>
777
+ * <li>
778
+ * <p>
779
+ * <code>VNM</code>: Vietnam's view on the Paracel Islands and Spratly Islands</p>
780
+ * </li>
781
+ * </ul>
782
+ * @public
783
+ */
784
+ PoliticalView?: string;
785
+ /**
786
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4
787
+ * signature must be provided when making a request. </p>
788
+ * @public
789
+ */
790
+ Key?: string;
791
+ }
792
+ /**
793
+ * @public
794
+ */
795
+ export interface GetStyleDescriptorResponse {
796
+ /**
797
+ * <p>This Blob contains the body of the style descriptor which is in application/json format.</p>
798
+ * @public
799
+ */
800
+ Blob?: Uint8Array;
801
+ /**
802
+ * <p>Header that represents the format of the response. The response returns the following as the HTTP body.</p>
803
+ * @public
804
+ */
805
+ ContentType?: string;
806
+ /**
807
+ * <p>Header that instructs caching configuration for the client.</p>
808
+ * @public
809
+ */
810
+ CacheControl?: string;
811
+ /**
812
+ * <p>The style descriptor's Etag.</p>
813
+ * @public
814
+ */
815
+ ETag?: string;
816
+ }
817
+ /**
818
+ * @public
819
+ */
820
+ export interface GetTileRequest {
821
+ /**
822
+ * <p>Specifies the desired tile set.</p>
823
+ * <p>Valid Values: <code>raster.satellite | vector.basemap</code>
824
+ * </p>
825
+ * @public
826
+ */
827
+ Tileset: string | undefined;
828
+ /**
829
+ * <p>The zoom value for the map tile.</p>
830
+ * @public
831
+ */
832
+ Z: string | undefined;
833
+ /**
834
+ * <p>The X axis value for the map tile. Must be between 0 and 19.</p>
835
+ * @public
836
+ */
837
+ X: string | undefined;
838
+ /**
839
+ * <p>The Y axis value for the map tile.</p>
840
+ * @public
841
+ */
842
+ Y: string | undefined;
843
+ /**
844
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4
845
+ * signature must be provided when making a request. </p>
846
+ * @public
847
+ */
848
+ Key?: string;
849
+ }
850
+ /**
851
+ * @public
852
+ */
853
+ export interface GetTileResponse {
854
+ /**
855
+ * <p>The blob represents a vector tile in <code>mvt</code> format for the
856
+ * <code>GetTile</code> API.</p>
857
+ * @public
858
+ */
859
+ Blob?: Uint8Array;
860
+ /**
861
+ * <p>Header that represents the format of the response. The response returns the following as the HTTP body.</p>
862
+ * @public
863
+ */
864
+ ContentType?: string;
865
+ /**
866
+ * <p>Header that instructs caching configuration for the client.</p>
867
+ * @public
868
+ */
869
+ CacheControl?: string;
870
+ /**
871
+ * <p>The pricing bucket for which the request is charged at.</p>
872
+ * @public
873
+ */
874
+ ETag?: string;
875
+ /**
876
+ * <p>The pricing bucket for which the request is charged at.</p>
877
+ * @public
878
+ */
879
+ PricingBucket: string | undefined;
880
+ }
881
+ /**
882
+ * @internal
883
+ */
884
+ export declare const GetStaticMapRequestFilterSensitiveLog: (obj: GetStaticMapRequest) => any;
885
+ /**
886
+ * @internal
887
+ */
888
+ export declare const GetStyleDescriptorRequestFilterSensitiveLog: (obj: GetStyleDescriptorRequest) => any;
889
+ /**
890
+ * @internal
891
+ */
892
+ export declare const GetTileRequestFilterSensitiveLog: (obj: GetTileRequest) => any;