@aws-sdk/client-location 3.296.0 → 3.297.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 (74) hide show
  1. package/dist-types/Location.d.ts +60 -1
  2. package/dist-types/LocationClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateTrackerConsumerCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchDeleteDevicePositionHistoryCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchDeleteGeofenceCommand.d.ts +16 -0
  6. package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +16 -0
  7. package/dist-types/commands/BatchGetDevicePositionCommand.d.ts +16 -0
  8. package/dist-types/commands/BatchPutGeofenceCommand.d.ts +16 -0
  9. package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +17 -1
  10. package/dist-types/commands/CalculateRouteCommand.d.ts +16 -0
  11. package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateGeofenceCollectionCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateKeyCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateMapCommand.d.ts +16 -0
  15. package/dist-types/commands/CreatePlaceIndexCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +16 -0
  17. package/dist-types/commands/CreateTrackerCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteGeofenceCollectionCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteKeyCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteMapCommand.d.ts +16 -0
  21. package/dist-types/commands/DeletePlaceIndexCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteTrackerCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeGeofenceCollectionCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeKeyCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeMapCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribePlaceIndexCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeRouteCalculatorCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeTrackerCommand.d.ts +16 -0
  30. package/dist-types/commands/DisassociateTrackerConsumerCommand.d.ts +16 -0
  31. package/dist-types/commands/GetDevicePositionCommand.d.ts +16 -0
  32. package/dist-types/commands/GetDevicePositionHistoryCommand.d.ts +16 -0
  33. package/dist-types/commands/GetGeofenceCommand.d.ts +16 -0
  34. package/dist-types/commands/GetMapGlyphsCommand.d.ts +16 -0
  35. package/dist-types/commands/GetMapSpritesCommand.d.ts +16 -0
  36. package/dist-types/commands/GetMapStyleDescriptorCommand.d.ts +16 -0
  37. package/dist-types/commands/GetMapTileCommand.d.ts +16 -0
  38. package/dist-types/commands/GetPlaceCommand.d.ts +16 -0
  39. package/dist-types/commands/ListDevicePositionsCommand.d.ts +16 -0
  40. package/dist-types/commands/ListGeofenceCollectionsCommand.d.ts +16 -0
  41. package/dist-types/commands/ListGeofencesCommand.d.ts +16 -0
  42. package/dist-types/commands/ListKeysCommand.d.ts +16 -0
  43. package/dist-types/commands/ListMapsCommand.d.ts +16 -0
  44. package/dist-types/commands/ListPlaceIndexesCommand.d.ts +16 -0
  45. package/dist-types/commands/ListRouteCalculatorsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  47. package/dist-types/commands/ListTrackerConsumersCommand.d.ts +16 -0
  48. package/dist-types/commands/ListTrackersCommand.d.ts +16 -0
  49. package/dist-types/commands/PutGeofenceCommand.d.ts +16 -0
  50. package/dist-types/commands/SearchPlaceIndexForPositionCommand.d.ts +16 -0
  51. package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +16 -0
  52. package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +16 -0
  53. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  54. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  55. package/dist-types/commands/UpdateGeofenceCollectionCommand.d.ts +16 -0
  56. package/dist-types/commands/UpdateKeyCommand.d.ts +16 -0
  57. package/dist-types/commands/UpdateMapCommand.d.ts +16 -0
  58. package/dist-types/commands/UpdatePlaceIndexCommand.d.ts +16 -0
  59. package/dist-types/commands/UpdateRouteCalculatorCommand.d.ts +16 -0
  60. package/dist-types/commands/UpdateTrackerCommand.d.ts +16 -0
  61. package/dist-types/models/LocationServiceException.d.ts +2 -0
  62. package/dist-types/models/models_0.d.ts +434 -3
  63. package/dist-types/pagination/GetDevicePositionHistoryPaginator.d.ts +3 -0
  64. package/dist-types/pagination/Interfaces.d.ts +3 -0
  65. package/dist-types/pagination/ListDevicePositionsPaginator.d.ts +3 -0
  66. package/dist-types/pagination/ListGeofenceCollectionsPaginator.d.ts +3 -0
  67. package/dist-types/pagination/ListGeofencesPaginator.d.ts +3 -0
  68. package/dist-types/pagination/ListKeysPaginator.d.ts +3 -0
  69. package/dist-types/pagination/ListMapsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/ListPlaceIndexesPaginator.d.ts +3 -0
  71. package/dist-types/pagination/ListRouteCalculatorsPaginator.d.ts +3 -0
  72. package/dist-types/pagination/ListTrackerConsumersPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListTrackersPaginator.d.ts +3 -0
  74. package/package.json +3 -3
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { LocationServiceException as __BaseException } from "./LocationServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>The request was denied because of insufficient access or permissions. Check with an
5
6
  * administrator to verify your permissions.</p>
6
7
  */
@@ -13,8 +14,12 @@ export declare class AccessDeniedException extends __BaseException {
13
14
  */
14
15
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
16
  }
17
+ /**
18
+ * @public
19
+ */
16
20
  export type Status = "Active" | "Expired";
17
21
  /**
22
+ * @public
18
23
  * <p>Options for filtering API keys.</p>
19
24
  */
20
25
  export interface ApiKeyFilter {
@@ -24,6 +29,7 @@ export interface ApiKeyFilter {
24
29
  KeyStatus?: Status | string;
25
30
  }
26
31
  /**
32
+ * @public
27
33
  * <p>The request was unsuccessful because of a conflict.</p>
28
34
  */
29
35
  export declare class ConflictException extends __BaseException {
@@ -36,6 +42,7 @@ export declare class ConflictException extends __BaseException {
36
42
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
37
43
  }
38
44
  /**
45
+ * @public
39
46
  * <p>API Restrictions on the allowed actions, resources, and referers for an API key
40
47
  * resource.</p>
41
48
  */
@@ -124,6 +131,9 @@ export interface ApiKeyRestrictions {
124
131
  */
125
132
  AllowReferers?: string[];
126
133
  }
134
+ /**
135
+ * @public
136
+ */
127
137
  export interface CreateKeyRequest {
128
138
  /**
129
139
  * <p>A custom name for the API key resource.</p>
@@ -191,6 +201,9 @@ export interface CreateKeyRequest {
191
201
  */
192
202
  Tags?: Record<string, string>;
193
203
  }
204
+ /**
205
+ * @public
206
+ */
194
207
  export interface CreateKeyResponse {
195
208
  /**
196
209
  * <p>The key value/string of an API key. This value is used when making API calls to
@@ -220,6 +233,7 @@ export interface CreateKeyResponse {
220
233
  CreateTime: Date | undefined;
221
234
  }
222
235
  /**
236
+ * @public
223
237
  * <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
224
238
  */
225
239
  export declare class InternalServerException extends __BaseException {
@@ -233,6 +247,7 @@ export declare class InternalServerException extends __BaseException {
233
247
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
234
248
  }
235
249
  /**
250
+ * @public
236
251
  * <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html">quota</a>
237
252
  * set for Amazon Location Service.</p>
238
253
  */
@@ -249,6 +264,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
249
264
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
250
265
  }
251
266
  /**
267
+ * @public
252
268
  * <p>The request was denied because of request throttling.</p>
253
269
  */
254
270
  export declare class ThrottlingException extends __BaseException {
@@ -262,6 +278,7 @@ export declare class ThrottlingException extends __BaseException {
262
278
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
263
279
  }
264
280
  /**
281
+ * @public
265
282
  * <p>The input failed to meet the constraints specified by the AWS service in a specified
266
283
  * field. </p>
267
284
  */
@@ -275,8 +292,12 @@ export interface ValidationExceptionField {
275
292
  */
276
293
  Message: string | undefined;
277
294
  }
295
+ /**
296
+ * @public
297
+ */
278
298
  export type ValidationExceptionReason = "CannotParse" | "FieldValidationFailed" | "Missing" | "Other" | "UnknownOperation";
279
299
  /**
300
+ * @public
280
301
  * <p>The input failed to meet the constraints specified by the AWS service. </p>
281
302
  */
282
303
  export declare class ValidationException extends __BaseException {
@@ -296,15 +317,22 @@ export declare class ValidationException extends __BaseException {
296
317
  */
297
318
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
298
319
  }
320
+ /**
321
+ * @public
322
+ */
299
323
  export interface DeleteKeyRequest {
300
324
  /**
301
325
  * <p>The name of the API key to delete.</p>
302
326
  */
303
327
  KeyName: string | undefined;
304
328
  }
329
+ /**
330
+ * @public
331
+ */
305
332
  export interface DeleteKeyResponse {
306
333
  }
307
334
  /**
335
+ * @public
308
336
  * <p>The resource that you've entered was not found in your AWS account.</p>
309
337
  */
310
338
  export declare class ResourceNotFoundException extends __BaseException {
@@ -316,12 +344,18 @@ export declare class ResourceNotFoundException extends __BaseException {
316
344
  */
317
345
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
318
346
  }
347
+ /**
348
+ * @public
349
+ */
319
350
  export interface DescribeKeyRequest {
320
351
  /**
321
352
  * <p>The name of the API key resource.</p>
322
353
  */
323
354
  KeyName: string | undefined;
324
355
  }
356
+ /**
357
+ * @public
358
+ */
325
359
  export interface DescribeKeyResponse {
326
360
  /**
327
361
  * <p>The key value/string of an API key.</p>
@@ -372,6 +406,9 @@ export interface DescribeKeyResponse {
372
406
  */
373
407
  Tags?: Record<string, string>;
374
408
  }
409
+ /**
410
+ * @public
411
+ */
375
412
  export interface ListKeysRequest {
376
413
  /**
377
414
  * <p>An optional limit for the number of resources returned in a single call. </p>
@@ -393,6 +430,7 @@ export interface ListKeysRequest {
393
430
  Filter?: ApiKeyFilter;
394
431
  }
395
432
  /**
433
+ * @public
396
434
  * <p>An API key resource listed in your Amazon Web Services account.</p>
397
435
  */
398
436
  export interface ListKeysResponseEntry {
@@ -425,6 +463,9 @@ export interface ListKeysResponseEntry {
425
463
  */
426
464
  UpdateTime: Date | undefined;
427
465
  }
466
+ /**
467
+ * @public
468
+ */
428
469
  export interface ListKeysResponse {
429
470
  /**
430
471
  * <p>Contains API key resources in your Amazon Web Services account. Details include API key
@@ -437,6 +478,9 @@ export interface ListKeysResponse {
437
478
  */
438
479
  NextToken?: string;
439
480
  }
481
+ /**
482
+ * @public
483
+ */
440
484
  export interface UpdateKeyRequest {
441
485
  /**
442
486
  * <p>The name of the API key resource to update.</p>
@@ -472,6 +516,9 @@ export interface UpdateKeyRequest {
472
516
  */
473
517
  Restrictions?: ApiKeyRestrictions;
474
518
  }
519
+ /**
520
+ * @public
521
+ */
475
522
  export interface UpdateKeyResponse {
476
523
  /**
477
524
  * <p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify
@@ -495,6 +542,9 @@ export interface UpdateKeyResponse {
495
542
  */
496
543
  UpdateTime: Date | undefined;
497
544
  }
545
+ /**
546
+ * @public
547
+ */
498
548
  export interface AssociateTrackerConsumerRequest {
499
549
  /**
500
550
  * <p>The name of the tracker resource to be associated with a geofence collection.</p>
@@ -513,8 +563,14 @@ export interface AssociateTrackerConsumerRequest {
513
563
  */
514
564
  ConsumerArn: string | undefined;
515
565
  }
566
+ /**
567
+ * @public
568
+ */
516
569
  export interface AssociateTrackerConsumerResponse {
517
570
  }
571
+ /**
572
+ * @public
573
+ */
518
574
  export interface BatchDeleteDevicePositionHistoryRequest {
519
575
  /**
520
576
  * <p>The name of the tracker resource to delete the device position history from.</p>
@@ -532,8 +588,12 @@ export interface BatchDeleteDevicePositionHistoryRequest {
532
588
  */
533
589
  DeviceIds: string[] | undefined;
534
590
  }
591
+ /**
592
+ * @public
593
+ */
535
594
  export type BatchItemErrorCode = "AccessDeniedError" | "ConflictError" | "InternalServerError" | "ResourceNotFoundError" | "ThrottlingError" | "ValidationError";
536
595
  /**
596
+ * @public
537
597
  * <p>Contains the batch request error details associated with the request.</p>
538
598
  */
539
599
  export interface BatchItemError {
@@ -547,6 +607,7 @@ export interface BatchItemError {
547
607
  Message?: string;
548
608
  }
549
609
  /**
610
+ * @public
550
611
  * <p>Contains the tracker resource details.</p>
551
612
  */
552
613
  export interface BatchDeleteDevicePositionHistoryError {
@@ -559,12 +620,18 @@ export interface BatchDeleteDevicePositionHistoryError {
559
620
  */
560
621
  Error: BatchItemError | undefined;
561
622
  }
623
+ /**
624
+ * @public
625
+ */
562
626
  export interface BatchDeleteDevicePositionHistoryResponse {
563
627
  /**
564
628
  * <p>Contains error details for each device history that failed to delete.</p>
565
629
  */
566
630
  Errors: BatchDeleteDevicePositionHistoryError[] | undefined;
567
631
  }
632
+ /**
633
+ * @public
634
+ */
568
635
  export interface BatchDeleteGeofenceRequest {
569
636
  /**
570
637
  * <p>The geofence collection storing the geofences to be deleted.</p>
@@ -576,6 +643,7 @@ export interface BatchDeleteGeofenceRequest {
576
643
  GeofenceIds: string[] | undefined;
577
644
  }
578
645
  /**
646
+ * @public
579
647
  * <p>Contains error details for each geofence that failed to delete from the geofence
580
648
  * collection.</p>
581
649
  */
@@ -589,6 +657,9 @@ export interface BatchDeleteGeofenceError {
589
657
  */
590
658
  Error: BatchItemError | undefined;
591
659
  }
660
+ /**
661
+ * @public
662
+ */
592
663
  export interface BatchDeleteGeofenceResponse {
593
664
  /**
594
665
  * <p>Contains error details for each geofence that failed to delete.</p>
@@ -596,6 +667,7 @@ export interface BatchDeleteGeofenceResponse {
596
667
  Errors: BatchDeleteGeofenceError[] | undefined;
597
668
  }
598
669
  /**
670
+ * @public
599
671
  * <p>Defines the level of certainty of the position.</p>
600
672
  */
601
673
  export interface PositionalAccuracy {
@@ -606,6 +678,7 @@ export interface PositionalAccuracy {
606
678
  Horizontal: number | undefined;
607
679
  }
608
680
  /**
681
+ * @public
609
682
  * <p>Contains the position update details for a device.</p>
610
683
  */
611
684
  export interface DevicePositionUpdate {
@@ -637,6 +710,9 @@ export interface DevicePositionUpdate {
637
710
  */
638
711
  PositionProperties?: Record<string, string>;
639
712
  }
713
+ /**
714
+ * @public
715
+ */
640
716
  export interface BatchEvaluateGeofencesRequest {
641
717
  /**
642
718
  * <p>The geofence collection used in evaluating the position of devices against its
@@ -650,6 +726,7 @@ export interface BatchEvaluateGeofencesRequest {
650
726
  DevicePositionUpdates: DevicePositionUpdate[] | undefined;
651
727
  }
652
728
  /**
729
+ * @public
653
730
  * <p>Contains error details for each device that failed to evaluate its position against
654
731
  * the geofences in a given geofence collection.</p>
655
732
  */
@@ -669,6 +746,9 @@ export interface BatchEvaluateGeofencesError {
669
746
  */
670
747
  Error: BatchItemError | undefined;
671
748
  }
749
+ /**
750
+ * @public
751
+ */
672
752
  export interface BatchEvaluateGeofencesResponse {
673
753
  /**
674
754
  * <p>Contains error details for each device that failed to evaluate its position against
@@ -676,6 +756,9 @@ export interface BatchEvaluateGeofencesResponse {
676
756
  */
677
757
  Errors: BatchEvaluateGeofencesError[] | undefined;
678
758
  }
759
+ /**
760
+ * @public
761
+ */
679
762
  export interface BatchGetDevicePositionRequest {
680
763
  /**
681
764
  * <p>The tracker resource retrieving the device position.</p>
@@ -694,6 +777,7 @@ export interface BatchGetDevicePositionRequest {
694
777
  DeviceIds: string[] | undefined;
695
778
  }
696
779
  /**
780
+ * @public
697
781
  * <p>Contains the device position details.</p>
698
782
  */
699
783
  export interface DevicePosition {
@@ -725,6 +809,7 @@ export interface DevicePosition {
725
809
  PositionProperties?: Record<string, string>;
726
810
  }
727
811
  /**
812
+ * @public
728
813
  * <p>Contains error details for each device that didn't return a position.</p>
729
814
  */
730
815
  export interface BatchGetDevicePositionError {
@@ -737,6 +822,9 @@ export interface BatchGetDevicePositionError {
737
822
  */
738
823
  Error: BatchItemError | undefined;
739
824
  }
825
+ /**
826
+ * @public
827
+ */
740
828
  export interface BatchGetDevicePositionResponse {
741
829
  /**
742
830
  * <p>Contains error details for each device that failed to send its position to the tracker
@@ -750,6 +838,7 @@ export interface BatchGetDevicePositionResponse {
750
838
  DevicePositions: DevicePosition[] | undefined;
751
839
  }
752
840
  /**
841
+ * @public
753
842
  * <p>A circle on the earth, as defined by a center point and a radius.</p>
754
843
  */
755
844
  export interface Circle {
@@ -765,6 +854,7 @@ export interface Circle {
765
854
  Radius: number | undefined;
766
855
  }
767
856
  /**
857
+ * @public
768
858
  * <p>Contains the geofence geometry details.</p>
769
859
  * <p>A geofence geometry is made up of either a polygon or a circle. Can be either a
770
860
  * polygon or a circle. Including both will return a validation error.</p>
@@ -796,6 +886,7 @@ export interface GeofenceGeometry {
796
886
  Circle?: Circle;
797
887
  }
798
888
  /**
889
+ * @public
799
890
  * <p>Contains geofence geometry details. </p>
800
891
  */
801
892
  export interface BatchPutGeofenceRequestEntry {
@@ -813,6 +904,9 @@ export interface BatchPutGeofenceRequestEntry {
813
904
  */
814
905
  Geometry: GeofenceGeometry | undefined;
815
906
  }
907
+ /**
908
+ * @public
909
+ */
816
910
  export interface BatchPutGeofenceRequest {
817
911
  /**
818
912
  * <p>The geofence collection storing the geofences.</p>
@@ -824,6 +918,7 @@ export interface BatchPutGeofenceRequest {
824
918
  Entries: BatchPutGeofenceRequestEntry[] | undefined;
825
919
  }
826
920
  /**
921
+ * @public
827
922
  * <p>Contains error details for each geofence that failed to be stored in a given geofence
828
923
  * collection.</p>
829
924
  */
@@ -838,6 +933,7 @@ export interface BatchPutGeofenceError {
838
933
  Error: BatchItemError | undefined;
839
934
  }
840
935
  /**
936
+ * @public
841
937
  * <p>Contains a summary of each geofence that was successfully stored in a given geofence
842
938
  * collection.</p>
843
939
  */
@@ -859,6 +955,9 @@ export interface BatchPutGeofenceSuccess {
859
955
  */
860
956
  UpdateTime: Date | undefined;
861
957
  }
958
+ /**
959
+ * @public
960
+ */
862
961
  export interface BatchPutGeofenceResponse {
863
962
  /**
864
963
  * <p>Contains each geofence that was successfully stored in a geofence collection.</p>
@@ -870,6 +969,9 @@ export interface BatchPutGeofenceResponse {
870
969
  */
871
970
  Errors: BatchPutGeofenceError[] | undefined;
872
971
  }
972
+ /**
973
+ * @public
974
+ */
873
975
  export interface BatchUpdateDevicePositionRequest {
874
976
  /**
875
977
  * <p>The name of the tracker resource to update.</p>
@@ -881,6 +983,7 @@ export interface BatchUpdateDevicePositionRequest {
881
983
  Updates: DevicePositionUpdate[] | undefined;
882
984
  }
883
985
  /**
986
+ * @public
884
987
  * <p>Contains error details for each device that failed to update its position.</p>
885
988
  */
886
989
  export interface BatchUpdateDevicePositionError {
@@ -899,6 +1002,9 @@ export interface BatchUpdateDevicePositionError {
899
1002
  */
900
1003
  Error: BatchItemError | undefined;
901
1004
  }
1005
+ /**
1006
+ * @public
1007
+ */
902
1008
  export interface BatchUpdateDevicePositionResponse {
903
1009
  /**
904
1010
  * <p>Contains error details for each device that failed to update its position.</p>
@@ -906,6 +1012,7 @@ export interface BatchUpdateDevicePositionResponse {
906
1012
  Errors: BatchUpdateDevicePositionError[] | undefined;
907
1013
  }
908
1014
  /**
1015
+ * @public
909
1016
  * <p>Contains details about additional route preferences for requests that specify
910
1017
  * <code>TravelMode</code> as <code>Car</code>.</p>
911
1018
  */
@@ -927,10 +1034,20 @@ export interface CalculateRouteCarModeOptions {
927
1034
  */
928
1035
  AvoidTolls?: boolean;
929
1036
  }
1037
+ /**
1038
+ * @public
1039
+ */
930
1040
  export type DistanceUnit = "Kilometers" | "Miles";
1041
+ /**
1042
+ * @public
1043
+ */
931
1044
  export type TravelMode = "Bicycle" | "Car" | "Motorcycle" | "Truck" | "Walking";
1045
+ /**
1046
+ * @public
1047
+ */
932
1048
  export type DimensionUnit = "Feet" | "Meters";
933
1049
  /**
1050
+ * @public
934
1051
  * <p>Contains details about the truck dimensions in the unit of measurement that you
935
1052
  * specify. Used to filter out roads that can't support or allow the specified dimensions
936
1053
  * for requests that specify <code>TravelMode</code> as <code>Truck</code>.</p>
@@ -985,8 +1102,12 @@ export interface TruckDimensions {
985
1102
  */
986
1103
  Unit?: DimensionUnit | string;
987
1104
  }
1105
+ /**
1106
+ * @public
1107
+ */
988
1108
  export type VehicleWeightUnit = "Kilograms" | "Pounds";
989
1109
  /**
1110
+ * @public
990
1111
  * <p>Contains details about the truck's weight specifications. Used to avoid roads that
991
1112
  * can't support or allow the total weight for requests that specify
992
1113
  * <code>TravelMode</code> as <code>Truck</code>.</p>
@@ -1009,6 +1130,7 @@ export interface TruckWeight {
1009
1130
  Unit?: VehicleWeightUnit | string;
1010
1131
  }
1011
1132
  /**
1133
+ * @public
1012
1134
  * <p>Contains details about additional route preferences for requests that specify
1013
1135
  * <code>TravelMode</code> as <code>Truck</code>.</p>
1014
1136
  */
@@ -1041,6 +1163,9 @@ export interface CalculateRouteTruckModeOptions {
1041
1163
  */
1042
1164
  Weight?: TruckWeight;
1043
1165
  }
1166
+ /**
1167
+ * @public
1168
+ */
1044
1169
  export interface CalculateRouteRequest {
1045
1170
  /**
1046
1171
  * <p>The name of the route calculator resource that you want to use to calculate the route.
@@ -1197,6 +1322,7 @@ export interface CalculateRouteRequest {
1197
1322
  TruckModeOptions?: CalculateRouteTruckModeOptions;
1198
1323
  }
1199
1324
  /**
1325
+ * @public
1200
1326
  * <p>Contains the geometry details for each path between a pair of positions. Used in
1201
1327
  * plotting a route leg on a map.</p>
1202
1328
  */
@@ -1216,6 +1342,7 @@ export interface LegGeometry {
1216
1342
  LineString?: number[][];
1217
1343
  }
1218
1344
  /**
1345
+ * @public
1219
1346
  * <p> Represents an element of a leg within a route. A step contains instructions for how
1220
1347
  * to move to the next step in the leg. </p>
1221
1348
  */
@@ -1251,6 +1378,7 @@ export interface Step {
1251
1378
  GeometryOffset?: number;
1252
1379
  }
1253
1380
  /**
1381
+ * @public
1254
1382
  * <p>Contains the calculated route's details for each path between a pair of positions. The
1255
1383
  * number of legs returned corresponds to one fewer than the total number of positions in
1256
1384
  * the request. </p>
@@ -1326,6 +1454,7 @@ export interface Leg {
1326
1454
  Steps: Step[] | undefined;
1327
1455
  }
1328
1456
  /**
1457
+ * @public
1329
1458
  * <p>A summary of the calculated route.</p>
1330
1459
  */
1331
1460
  export interface CalculateRouteSummary {
@@ -1401,6 +1530,7 @@ export interface CalculateRouteSummary {
1401
1530
  DistanceUnit: DistanceUnit | string | undefined;
1402
1531
  }
1403
1532
  /**
1533
+ * @public
1404
1534
  * <p>Returns the result of the route calculation. Metadata includes legs and route
1405
1535
  * summary.</p>
1406
1536
  */
@@ -1443,6 +1573,9 @@ export interface CalculateRouteResponse {
1443
1573
  */
1444
1574
  Summary: CalculateRouteSummary | undefined;
1445
1575
  }
1576
+ /**
1577
+ * @public
1578
+ */
1446
1579
  export interface CalculateRouteMatrixRequest {
1447
1580
  /**
1448
1581
  * <p>The name of the route calculator resource that you want to use to calculate the route
@@ -1567,8 +1700,12 @@ export interface CalculateRouteMatrixRequest {
1567
1700
  */
1568
1701
  TruckModeOptions?: CalculateRouteTruckModeOptions;
1569
1702
  }
1703
+ /**
1704
+ * @public
1705
+ */
1570
1706
  export type RouteMatrixErrorCode = "DeparturePositionNotFound" | "DestinationPositionNotFound" | "OtherValidationError" | "PositionsNotFound" | "RouteNotFound" | "RouteTooLong";
1571
1707
  /**
1708
+ * @public
1572
1709
  * <p>An error corresponding to the calculation of a route between the
1573
1710
  * <code>DeparturePosition</code> and <code>DestinationPosition</code>.</p>
1574
1711
  * <p>The error code can be one of the following:</p>
@@ -1628,6 +1765,7 @@ export interface RouteMatrixEntryError {
1628
1765
  Message?: string;
1629
1766
  }
1630
1767
  /**
1768
+ * @public
1631
1769
  * <p>The result for the calculated route of one <code>DeparturePosition</code>
1632
1770
  * <code>DestinationPosition</code> pair.</p>
1633
1771
  */
@@ -1647,6 +1785,7 @@ export interface RouteMatrixEntry {
1647
1785
  Error?: RouteMatrixEntryError;
1648
1786
  }
1649
1787
  /**
1788
+ * @public
1650
1789
  * <p>A summary of the calculated route matrix.</p>
1651
1790
  */
1652
1791
  export interface CalculateRouteMatrixSummary {
@@ -1691,6 +1830,7 @@ export interface CalculateRouteMatrixSummary {
1691
1830
  DistanceUnit: DistanceUnit | string | undefined;
1692
1831
  }
1693
1832
  /**
1833
+ * @public
1694
1834
  * <p>Returns the result of the route matrix calculation.</p>
1695
1835
  */
1696
1836
  export interface CalculateRouteMatrixResponse {
@@ -1721,7 +1861,13 @@ export interface CalculateRouteMatrixResponse {
1721
1861
  */
1722
1862
  Summary: CalculateRouteMatrixSummary | undefined;
1723
1863
  }
1864
+ /**
1865
+ * @public
1866
+ */
1724
1867
  export type PricingPlan = "MobileAssetManagement" | "MobileAssetTracking" | "RequestBasedUsage";
1868
+ /**
1869
+ * @public
1870
+ */
1725
1871
  export interface CreateGeofenceCollectionRequest {
1726
1872
  /**
1727
1873
  * <p>A custom name for the geofence collection.</p>
@@ -1794,6 +1940,9 @@ export interface CreateGeofenceCollectionRequest {
1794
1940
  */
1795
1941
  KmsKeyId?: string;
1796
1942
  }
1943
+ /**
1944
+ * @public
1945
+ */
1797
1946
  export interface CreateGeofenceCollectionResponse {
1798
1947
  /**
1799
1948
  * <p>The name for the geofence collection.</p>
@@ -1819,6 +1968,7 @@ export interface CreateGeofenceCollectionResponse {
1819
1968
  CreateTime: Date | undefined;
1820
1969
  }
1821
1970
  /**
1971
+ * @public
1822
1972
  * <p>Specifies the map tile style selected from an available provider.</p>
1823
1973
  */
1824
1974
  export interface MapConfiguration {
@@ -1966,6 +2116,9 @@ export interface MapConfiguration {
1966
2116
  */
1967
2117
  Style: string | undefined;
1968
2118
  }
2119
+ /**
2120
+ * @public
2121
+ */
1969
2122
  export interface CreateMapRequest {
1970
2123
  /**
1971
2124
  * <p>The name for the map resource.</p>
@@ -2030,6 +2183,9 @@ export interface CreateMapRequest {
2030
2183
  */
2031
2184
  Tags?: Record<string, string>;
2032
2185
  }
2186
+ /**
2187
+ * @public
2188
+ */
2033
2189
  export interface CreateMapResponse {
2034
2190
  /**
2035
2191
  * <p>The name of the map resource.</p>
@@ -2053,8 +2209,12 @@ export interface CreateMapResponse {
2053
2209
  */
2054
2210
  CreateTime: Date | undefined;
2055
2211
  }
2212
+ /**
2213
+ * @public
2214
+ */
2056
2215
  export type IntendedUse = "SingleUse" | "Storage";
2057
2216
  /**
2217
+ * @public
2058
2218
  * <p>Specifies the data storage option chosen for requesting Places.</p>
2059
2219
  * <important>
2060
2220
  * <p>When using Amazon Location Places:</p>
@@ -2094,6 +2254,9 @@ export interface DataSourceConfiguration {
2094
2254
  */
2095
2255
  IntendedUse?: IntendedUse | string;
2096
2256
  }
2257
+ /**
2258
+ * @public
2259
+ */
2097
2260
  export interface CreatePlaceIndexRequest {
2098
2261
  /**
2099
2262
  * <p>The name of the place index resource. </p>
@@ -2190,6 +2353,9 @@ export interface CreatePlaceIndexRequest {
2190
2353
  */
2191
2354
  Tags?: Record<string, string>;
2192
2355
  }
2356
+ /**
2357
+ * @public
2358
+ */
2193
2359
  export interface CreatePlaceIndexResponse {
2194
2360
  /**
2195
2361
  * <p>The name for the place index resource.</p>
@@ -2213,6 +2379,9 @@ export interface CreatePlaceIndexResponse {
2213
2379
  */
2214
2380
  CreateTime: Date | undefined;
2215
2381
  }
2382
+ /**
2383
+ * @public
2384
+ */
2216
2385
  export interface CreateRouteCalculatorRequest {
2217
2386
  /**
2218
2387
  * <p>The name of the route calculator resource. </p>
@@ -2278,8 +2447,8 @@ export interface CreateRouteCalculatorRequest {
2278
2447
  * helps manage, identify, search, and filter your resources by labelling them.</p>
2279
2448
  * <ul>
2280
2449
  * <li>
2281
- * <p>For example: { <code>"tag1" : "value1"</code>, <code>"tag2" :
2282
- * "value2"</code>}</p>
2450
+ * <p>For example: \{ <code>"tag1" : "value1"</code>, <code>"tag2" :
2451
+ * "value2"</code>\}</p>
2283
2452
  * </li>
2284
2453
  * </ul>
2285
2454
  * <p>Format: <code>"key" : "value"</code>
@@ -2309,6 +2478,9 @@ export interface CreateRouteCalculatorRequest {
2309
2478
  */
2310
2479
  Tags?: Record<string, string>;
2311
2480
  }
2481
+ /**
2482
+ * @public
2483
+ */
2312
2484
  export interface CreateRouteCalculatorResponse {
2313
2485
  /**
2314
2486
  * <p>The name of the route calculator resource. </p>
@@ -2343,7 +2515,13 @@ export interface CreateRouteCalculatorResponse {
2343
2515
  */
2344
2516
  CreateTime: Date | undefined;
2345
2517
  }
2518
+ /**
2519
+ * @public
2520
+ */
2346
2521
  export type PositionFiltering = "AccuracyBased" | "DistanceBased" | "TimeBased";
2522
+ /**
2523
+ * @public
2524
+ */
2347
2525
  export interface CreateTrackerRequest {
2348
2526
  /**
2349
2527
  * <p>The name for the tracker resource.</p>
@@ -2448,6 +2626,9 @@ export interface CreateTrackerRequest {
2448
2626
  */
2449
2627
  PositionFiltering?: PositionFiltering | string;
2450
2628
  }
2629
+ /**
2630
+ * @public
2631
+ */
2451
2632
  export interface CreateTrackerResponse {
2452
2633
  /**
2453
2634
  * <p>The name of the tracker resource.</p>
@@ -2471,52 +2652,88 @@ export interface CreateTrackerResponse {
2471
2652
  */
2472
2653
  CreateTime: Date | undefined;
2473
2654
  }
2655
+ /**
2656
+ * @public
2657
+ */
2474
2658
  export interface DeleteGeofenceCollectionRequest {
2475
2659
  /**
2476
2660
  * <p>The name of the geofence collection to be deleted.</p>
2477
2661
  */
2478
2662
  CollectionName: string | undefined;
2479
2663
  }
2664
+ /**
2665
+ * @public
2666
+ */
2480
2667
  export interface DeleteGeofenceCollectionResponse {
2481
2668
  }
2669
+ /**
2670
+ * @public
2671
+ */
2482
2672
  export interface DeleteMapRequest {
2483
2673
  /**
2484
2674
  * <p>The name of the map resource to be deleted.</p>
2485
2675
  */
2486
2676
  MapName: string | undefined;
2487
2677
  }
2678
+ /**
2679
+ * @public
2680
+ */
2488
2681
  export interface DeleteMapResponse {
2489
2682
  }
2683
+ /**
2684
+ * @public
2685
+ */
2490
2686
  export interface DeletePlaceIndexRequest {
2491
2687
  /**
2492
2688
  * <p>The name of the place index resource to be deleted.</p>
2493
2689
  */
2494
2690
  IndexName: string | undefined;
2495
2691
  }
2692
+ /**
2693
+ * @public
2694
+ */
2496
2695
  export interface DeletePlaceIndexResponse {
2497
2696
  }
2697
+ /**
2698
+ * @public
2699
+ */
2498
2700
  export interface DeleteRouteCalculatorRequest {
2499
2701
  /**
2500
2702
  * <p>The name of the route calculator resource to be deleted.</p>
2501
2703
  */
2502
2704
  CalculatorName: string | undefined;
2503
2705
  }
2706
+ /**
2707
+ * @public
2708
+ */
2504
2709
  export interface DeleteRouteCalculatorResponse {
2505
2710
  }
2711
+ /**
2712
+ * @public
2713
+ */
2506
2714
  export interface DeleteTrackerRequest {
2507
2715
  /**
2508
2716
  * <p>The name of the tracker resource to be deleted.</p>
2509
2717
  */
2510
2718
  TrackerName: string | undefined;
2511
2719
  }
2720
+ /**
2721
+ * @public
2722
+ */
2512
2723
  export interface DeleteTrackerResponse {
2513
2724
  }
2725
+ /**
2726
+ * @public
2727
+ */
2514
2728
  export interface DescribeGeofenceCollectionRequest {
2515
2729
  /**
2516
2730
  * <p>The name of the geofence collection.</p>
2517
2731
  */
2518
2732
  CollectionName: string | undefined;
2519
2733
  }
2734
+ /**
2735
+ * @public
2736
+ */
2520
2737
  export interface DescribeGeofenceCollectionResponse {
2521
2738
  /**
2522
2739
  * <p>The name of the geofence collection.</p>
@@ -2573,12 +2790,18 @@ export interface DescribeGeofenceCollectionResponse {
2573
2790
  */
2574
2791
  UpdateTime: Date | undefined;
2575
2792
  }
2793
+ /**
2794
+ * @public
2795
+ */
2576
2796
  export interface DescribeMapRequest {
2577
2797
  /**
2578
2798
  * <p>The name of the map resource.</p>
2579
2799
  */
2580
2800
  MapName: string | undefined;
2581
2801
  }
2802
+ /**
2803
+ * @public
2804
+ */
2582
2805
  export interface DescribeMapResponse {
2583
2806
  /**
2584
2807
  * <p>The map style selected from an available provider.</p>
@@ -2629,12 +2852,18 @@ export interface DescribeMapResponse {
2629
2852
  */
2630
2853
  UpdateTime: Date | undefined;
2631
2854
  }
2855
+ /**
2856
+ * @public
2857
+ */
2632
2858
  export interface DescribePlaceIndexRequest {
2633
2859
  /**
2634
2860
  * <p>The name of the place index resource.</p>
2635
2861
  */
2636
2862
  IndexName: string | undefined;
2637
2863
  }
2864
+ /**
2865
+ * @public
2866
+ */
2638
2867
  export interface DescribePlaceIndexResponse {
2639
2868
  /**
2640
2869
  * <p>The name of the place index resource being described.</p>
@@ -2703,12 +2932,18 @@ export interface DescribePlaceIndexResponse {
2703
2932
  */
2704
2933
  Tags?: Record<string, string>;
2705
2934
  }
2935
+ /**
2936
+ * @public
2937
+ */
2706
2938
  export interface DescribeRouteCalculatorRequest {
2707
2939
  /**
2708
2940
  * <p>The name of the route calculator resource.</p>
2709
2941
  */
2710
2942
  CalculatorName: string | undefined;
2711
2943
  }
2944
+ /**
2945
+ * @public
2946
+ */
2712
2947
  export interface DescribeRouteCalculatorResponse {
2713
2948
  /**
2714
2949
  * <p>The name of the route calculator resource being described.</p>
@@ -2786,12 +3021,18 @@ export interface DescribeRouteCalculatorResponse {
2786
3021
  */
2787
3022
  Tags?: Record<string, string>;
2788
3023
  }
3024
+ /**
3025
+ * @public
3026
+ */
2789
3027
  export interface DescribeTrackerRequest {
2790
3028
  /**
2791
3029
  * <p>The name of the tracker resource.</p>
2792
3030
  */
2793
3031
  TrackerName: string | undefined;
2794
3032
  }
3033
+ /**
3034
+ * @public
3035
+ */
2795
3036
  export interface DescribeTrackerResponse {
2796
3037
  /**
2797
3038
  * <p>The name of the tracker resource.</p>
@@ -2849,6 +3090,9 @@ export interface DescribeTrackerResponse {
2849
3090
  */
2850
3091
  PositionFiltering?: PositionFiltering | string;
2851
3092
  }
3093
+ /**
3094
+ * @public
3095
+ */
2852
3096
  export interface DisassociateTrackerConsumerRequest {
2853
3097
  /**
2854
3098
  * <p>The name of the tracker resource to be dissociated from the consumer.</p>
@@ -2867,8 +3111,14 @@ export interface DisassociateTrackerConsumerRequest {
2867
3111
  */
2868
3112
  ConsumerArn: string | undefined;
2869
3113
  }
3114
+ /**
3115
+ * @public
3116
+ */
2870
3117
  export interface DisassociateTrackerConsumerResponse {
2871
3118
  }
3119
+ /**
3120
+ * @public
3121
+ */
2872
3122
  export interface ListTagsForResourceRequest {
2873
3123
  /**
2874
3124
  * <p>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</p>
@@ -2882,19 +3132,25 @@ export interface ListTagsForResourceRequest {
2882
3132
  */
2883
3133
  ResourceArn: string | undefined;
2884
3134
  }
3135
+ /**
3136
+ * @public
3137
+ */
2885
3138
  export interface ListTagsForResourceResponse {
2886
3139
  /**
2887
3140
  * <p>Tags that have been applied to the specified resource. Tags are mapped from the tag
2888
3141
  * key to the tag value: <code>"TagKey" : "TagValue"</code>.</p>
2889
3142
  * <ul>
2890
3143
  * <li>
2891
- * <p>Format example: <code>{"tag1" : "value1", "tag2" : "value2"} </code>
3144
+ * <p>Format example: <code>\{"tag1" : "value1", "tag2" : "value2"\} </code>
2892
3145
  * </p>
2893
3146
  * </li>
2894
3147
  * </ul>
2895
3148
  */
2896
3149
  Tags?: Record<string, string>;
2897
3150
  }
3151
+ /**
3152
+ * @public
3153
+ */
2898
3154
  export interface TagResourceRequest {
2899
3155
  /**
2900
3156
  * <p>The Amazon Resource Name (ARN) of the resource whose tags you want to update.</p>
@@ -2937,8 +3193,14 @@ export interface TagResourceRequest {
2937
3193
  */
2938
3194
  Tags: Record<string, string> | undefined;
2939
3195
  }
3196
+ /**
3197
+ * @public
3198
+ */
2940
3199
  export interface TagResourceResponse {
2941
3200
  }
3201
+ /**
3202
+ * @public
3203
+ */
2942
3204
  export interface UntagResourceRequest {
2943
3205
  /**
2944
3206
  * <p>The Amazon Resource Name (ARN) of the resource from which you want to remove
@@ -2957,8 +3219,14 @@ export interface UntagResourceRequest {
2957
3219
  */
2958
3220
  TagKeys: string[] | undefined;
2959
3221
  }
3222
+ /**
3223
+ * @public
3224
+ */
2960
3225
  export interface UntagResourceResponse {
2961
3226
  }
3227
+ /**
3228
+ * @public
3229
+ */
2962
3230
  export interface GetGeofenceRequest {
2963
3231
  /**
2964
3232
  * <p>The geofence collection storing the target geofence.</p>
@@ -2969,6 +3237,9 @@ export interface GetGeofenceRequest {
2969
3237
  */
2970
3238
  GeofenceId: string | undefined;
2971
3239
  }
3240
+ /**
3241
+ * @public
3242
+ */
2972
3243
  export interface GetGeofenceResponse {
2973
3244
  /**
2974
3245
  * <p>The geofence identifier.</p>
@@ -3020,6 +3291,9 @@ export interface GetGeofenceResponse {
3020
3291
  */
3021
3292
  UpdateTime: Date | undefined;
3022
3293
  }
3294
+ /**
3295
+ * @public
3296
+ */
3023
3297
  export interface ListGeofenceCollectionsRequest {
3024
3298
  /**
3025
3299
  * <p>An optional limit for the number of resources returned in a single call. </p>
@@ -3036,6 +3310,7 @@ export interface ListGeofenceCollectionsRequest {
3036
3310
  NextToken?: string;
3037
3311
  }
3038
3312
  /**
3313
+ * @public
3039
3314
  * <p>Contains the geofence collection details.</p>
3040
3315
  */
3041
3316
  export interface ListGeofenceCollectionsResponseEntry {
@@ -3072,6 +3347,9 @@ export interface ListGeofenceCollectionsResponseEntry {
3072
3347
  */
3073
3348
  UpdateTime: Date | undefined;
3074
3349
  }
3350
+ /**
3351
+ * @public
3352
+ */
3075
3353
  export interface ListGeofenceCollectionsResponse {
3076
3354
  /**
3077
3355
  * <p>Lists the geofence collections that exist in your Amazon Web Services account.</p>
@@ -3083,6 +3361,9 @@ export interface ListGeofenceCollectionsResponse {
3083
3361
  */
3084
3362
  NextToken?: string;
3085
3363
  }
3364
+ /**
3365
+ * @public
3366
+ */
3086
3367
  export interface ListGeofencesRequest {
3087
3368
  /**
3088
3369
  * <p>The name of the geofence collection storing the list of geofences.</p>
@@ -3103,6 +3384,7 @@ export interface ListGeofencesRequest {
3103
3384
  MaxResults?: number;
3104
3385
  }
3105
3386
  /**
3387
+ * @public
3106
3388
  * <p>Contains a list of geofences stored in a given geofence collection.</p>
3107
3389
  */
3108
3390
  export interface ListGeofenceResponseEntry {
@@ -3156,6 +3438,9 @@ export interface ListGeofenceResponseEntry {
3156
3438
  */
3157
3439
  UpdateTime: Date | undefined;
3158
3440
  }
3441
+ /**
3442
+ * @public
3443
+ */
3159
3444
  export interface ListGeofencesResponse {
3160
3445
  /**
3161
3446
  * <p>Contains a list of geofences stored in the geofence collection.</p>
@@ -3167,6 +3452,9 @@ export interface ListGeofencesResponse {
3167
3452
  */
3168
3453
  NextToken?: string;
3169
3454
  }
3455
+ /**
3456
+ * @public
3457
+ */
3170
3458
  export interface PutGeofenceRequest {
3171
3459
  /**
3172
3460
  * <p>The geofence collection to store the geofence in.</p>
@@ -3186,6 +3474,9 @@ export interface PutGeofenceRequest {
3186
3474
  */
3187
3475
  Geometry: GeofenceGeometry | undefined;
3188
3476
  }
3477
+ /**
3478
+ * @public
3479
+ */
3189
3480
  export interface PutGeofenceResponse {
3190
3481
  /**
3191
3482
  * <p>The geofence identifier entered in the request.</p>
@@ -3204,6 +3495,9 @@ export interface PutGeofenceResponse {
3204
3495
  */
3205
3496
  UpdateTime: Date | undefined;
3206
3497
  }
3498
+ /**
3499
+ * @public
3500
+ */
3207
3501
  export interface UpdateGeofenceCollectionRequest {
3208
3502
  /**
3209
3503
  * <p>The name of the geofence collection to update.</p>
@@ -3227,6 +3521,9 @@ export interface UpdateGeofenceCollectionRequest {
3227
3521
  */
3228
3522
  Description?: string;
3229
3523
  }
3524
+ /**
3525
+ * @public
3526
+ */
3230
3527
  export interface UpdateGeofenceCollectionResponse {
3231
3528
  /**
3232
3529
  * <p>The name of the updated geofence collection.</p>
@@ -3251,6 +3548,9 @@ export interface UpdateGeofenceCollectionResponse {
3251
3548
  */
3252
3549
  UpdateTime: Date | undefined;
3253
3550
  }
3551
+ /**
3552
+ * @public
3553
+ */
3254
3554
  export interface GetDevicePositionRequest {
3255
3555
  /**
3256
3556
  * <p>The tracker resource receiving the position update.</p>
@@ -3261,6 +3561,9 @@ export interface GetDevicePositionRequest {
3261
3561
  */
3262
3562
  DeviceId: string | undefined;
3263
3563
  }
3564
+ /**
3565
+ * @public
3566
+ */
3264
3567
  export interface GetDevicePositionResponse {
3265
3568
  /**
3266
3569
  * <p>The device whose position you retrieved.</p>
@@ -3289,6 +3592,9 @@ export interface GetDevicePositionResponse {
3289
3592
  */
3290
3593
  PositionProperties?: Record<string, string>;
3291
3594
  }
3595
+ /**
3596
+ * @public
3597
+ */
3292
3598
  export interface GetDevicePositionHistoryRequest {
3293
3599
  /**
3294
3600
  * <p>The tracker resource receiving the request for the device position history.</p>
@@ -3338,6 +3644,9 @@ export interface GetDevicePositionHistoryRequest {
3338
3644
  */
3339
3645
  MaxResults?: number;
3340
3646
  }
3647
+ /**
3648
+ * @public
3649
+ */
3341
3650
  export interface GetDevicePositionHistoryResponse {
3342
3651
  /**
3343
3652
  * <p>Contains the position history details for the requested device.</p>
@@ -3349,6 +3658,9 @@ export interface GetDevicePositionHistoryResponse {
3349
3658
  */
3350
3659
  NextToken?: string;
3351
3660
  }
3661
+ /**
3662
+ * @public
3663
+ */
3352
3664
  export interface GetMapGlyphsRequest {
3353
3665
  /**
3354
3666
  * <p>The map resource associated with the glyph file.</p>
@@ -3446,6 +3758,9 @@ export interface GetMapGlyphsRequest {
3446
3758
  */
3447
3759
  Key?: string;
3448
3760
  }
3761
+ /**
3762
+ * @public
3763
+ */
3449
3764
  export interface GetMapGlyphsResponse {
3450
3765
  /**
3451
3766
  * <p>The glyph, as binary blob.</p>
@@ -3460,6 +3775,9 @@ export interface GetMapGlyphsResponse {
3460
3775
  */
3461
3776
  CacheControl?: string;
3462
3777
  }
3778
+ /**
3779
+ * @public
3780
+ */
3463
3781
  export interface GetMapSpritesRequest {
3464
3782
  /**
3465
3783
  * <p>The map resource associated with the sprite file.</p>
@@ -3498,6 +3816,9 @@ export interface GetMapSpritesRequest {
3498
3816
  */
3499
3817
  Key?: string;
3500
3818
  }
3819
+ /**
3820
+ * @public
3821
+ */
3501
3822
  export interface GetMapSpritesResponse {
3502
3823
  /**
3503
3824
  * <p>Contains the body of the sprite sheet or JSON offset file.</p>
@@ -3514,6 +3835,9 @@ export interface GetMapSpritesResponse {
3514
3835
  */
3515
3836
  CacheControl?: string;
3516
3837
  }
3838
+ /**
3839
+ * @public
3840
+ */
3517
3841
  export interface GetMapStyleDescriptorRequest {
3518
3842
  /**
3519
3843
  * <p>The map resource to retrieve the style descriptor from.</p>
@@ -3525,6 +3849,9 @@ export interface GetMapStyleDescriptorRequest {
3525
3849
  */
3526
3850
  Key?: string;
3527
3851
  }
3852
+ /**
3853
+ * @public
3854
+ */
3528
3855
  export interface GetMapStyleDescriptorResponse {
3529
3856
  /**
3530
3857
  * <p>Contains the body of the style descriptor.</p>
@@ -3540,6 +3867,9 @@ export interface GetMapStyleDescriptorResponse {
3540
3867
  */
3541
3868
  CacheControl?: string;
3542
3869
  }
3870
+ /**
3871
+ * @public
3872
+ */
3543
3873
  export interface GetMapTileRequest {
3544
3874
  /**
3545
3875
  * <p>The map resource to retrieve the map tiles from.</p>
@@ -3563,6 +3893,9 @@ export interface GetMapTileRequest {
3563
3893
  */
3564
3894
  Key?: string;
3565
3895
  }
3896
+ /**
3897
+ * @public
3898
+ */
3566
3899
  export interface GetMapTileResponse {
3567
3900
  /**
3568
3901
  * <p>Contains Mapbox Vector Tile (MVT) data.</p>
@@ -3578,6 +3911,9 @@ export interface GetMapTileResponse {
3578
3911
  */
3579
3912
  CacheControl?: string;
3580
3913
  }
3914
+ /**
3915
+ * @public
3916
+ */
3581
3917
  export interface GetPlaceRequest {
3582
3918
  /**
3583
3919
  * <p>The name of the place index resource that you want to use for the search.</p>
@@ -3606,6 +3942,7 @@ export interface GetPlaceRequest {
3606
3942
  Language?: string;
3607
3943
  }
3608
3944
  /**
3945
+ * @public
3609
3946
  * <p>Places uses a point geometry to specify a location or a Place.</p>
3610
3947
  */
3611
3948
  export interface PlaceGeometry {
@@ -3626,6 +3963,7 @@ export interface PlaceGeometry {
3626
3963
  Point?: number[];
3627
3964
  }
3628
3965
  /**
3966
+ * @public
3629
3967
  * <p>Information about a time zone. Includes the name of the time zone and the offset from
3630
3968
  * UTC in seconds.</p>
3631
3969
  */
@@ -3642,6 +3980,7 @@ export interface TimeZone {
3642
3980
  Offset?: number;
3643
3981
  }
3644
3982
  /**
3983
+ * @public
3645
3984
  * <p>Contains details about addresses or points of interest that match the search
3646
3985
  * criteria.</p>
3647
3986
  * <p>Not all details are included with all responses. Some details may only be returned by
@@ -3727,12 +4066,18 @@ export interface Place {
3727
4066
  */
3728
4067
  UnitNumber?: string;
3729
4068
  }
4069
+ /**
4070
+ * @public
4071
+ */
3730
4072
  export interface GetPlaceResponse {
3731
4073
  /**
3732
4074
  * <p>Details about the result, such as its address and position.</p>
3733
4075
  */
3734
4076
  Place: Place | undefined;
3735
4077
  }
4078
+ /**
4079
+ * @public
4080
+ */
3736
4081
  export interface ListDevicePositionsRequest {
3737
4082
  /**
3738
4083
  * <p>The tracker resource containing the requested devices.</p>
@@ -3753,6 +4098,7 @@ export interface ListDevicePositionsRequest {
3753
4098
  NextToken?: string;
3754
4099
  }
3755
4100
  /**
4101
+ * @public
3756
4102
  * <p>Contains the tracker resource details.</p>
3757
4103
  */
3758
4104
  export interface ListDevicePositionsResponseEntry {
@@ -3778,6 +4124,9 @@ export interface ListDevicePositionsResponseEntry {
3778
4124
  */
3779
4125
  PositionProperties?: Record<string, string>;
3780
4126
  }
4127
+ /**
4128
+ * @public
4129
+ */
3781
4130
  export interface ListDevicePositionsResponse {
3782
4131
  /**
3783
4132
  * <p>Contains details about each device's last known position. These details includes the device ID,
@@ -3790,6 +4139,9 @@ export interface ListDevicePositionsResponse {
3790
4139
  */
3791
4140
  NextToken?: string;
3792
4141
  }
4142
+ /**
4143
+ * @public
4144
+ */
3793
4145
  export interface ListMapsRequest {
3794
4146
  /**
3795
4147
  * <p>An optional limit for the number of resources returned in a single call. </p>
@@ -3806,6 +4158,7 @@ export interface ListMapsRequest {
3806
4158
  NextToken?: string;
3807
4159
  }
3808
4160
  /**
4161
+ * @public
3809
4162
  * <p>Contains details of an existing map resource in your Amazon Web Services account.</p>
3810
4163
  */
3811
4164
  export interface ListMapsResponseEntry {
@@ -3838,6 +4191,9 @@ export interface ListMapsResponseEntry {
3838
4191
  */
3839
4192
  UpdateTime: Date | undefined;
3840
4193
  }
4194
+ /**
4195
+ * @public
4196
+ */
3841
4197
  export interface ListMapsResponse {
3842
4198
  /**
3843
4199
  * <p>Contains a list of maps in your Amazon Web Services account</p>
@@ -3848,6 +4204,9 @@ export interface ListMapsResponse {
3848
4204
  */
3849
4205
  NextToken?: string;
3850
4206
  }
4207
+ /**
4208
+ * @public
4209
+ */
3851
4210
  export interface ListPlaceIndexesRequest {
3852
4211
  /**
3853
4212
  * <p>An optional limit for the maximum number of results returned in a single call.</p>
@@ -3864,6 +4223,7 @@ export interface ListPlaceIndexesRequest {
3864
4223
  NextToken?: string;
3865
4224
  }
3866
4225
  /**
4226
+ * @public
3867
4227
  * <p>A place index resource listed in your Amazon Web Services account.</p>
3868
4228
  */
3869
4229
  export interface ListPlaceIndexesResponseEntry {
@@ -3914,6 +4274,9 @@ export interface ListPlaceIndexesResponseEntry {
3914
4274
  */
3915
4275
  UpdateTime: Date | undefined;
3916
4276
  }
4277
+ /**
4278
+ * @public
4279
+ */
3917
4280
  export interface ListPlaceIndexesResponse {
3918
4281
  /**
3919
4282
  * <p>Lists the place index resources that exist in your Amazon Web Services account</p>
@@ -3925,6 +4288,9 @@ export interface ListPlaceIndexesResponse {
3925
4288
  */
3926
4289
  NextToken?: string;
3927
4290
  }
4291
+ /**
4292
+ * @public
4293
+ */
3928
4294
  export interface ListRouteCalculatorsRequest {
3929
4295
  /**
3930
4296
  * <p>An optional maximum number of results returned in a single call.</p>
@@ -3941,6 +4307,7 @@ export interface ListRouteCalculatorsRequest {
3941
4307
  NextToken?: string;
3942
4308
  }
3943
4309
  /**
4310
+ * @public
3944
4311
  * <p>A route calculator resource listed in your Amazon Web Services account.</p>
3945
4312
  */
3946
4313
  export interface ListRouteCalculatorsResponseEntry {
@@ -4004,6 +4371,9 @@ export interface ListRouteCalculatorsResponseEntry {
4004
4371
  */
4005
4372
  UpdateTime: Date | undefined;
4006
4373
  }
4374
+ /**
4375
+ * @public
4376
+ */
4007
4377
  export interface ListRouteCalculatorsResponse {
4008
4378
  /**
4009
4379
  * <p>Lists the route calculator resources that exist in your Amazon Web Services account</p>
@@ -4015,6 +4385,9 @@ export interface ListRouteCalculatorsResponse {
4015
4385
  */
4016
4386
  NextToken?: string;
4017
4387
  }
4388
+ /**
4389
+ * @public
4390
+ */
4018
4391
  export interface ListTrackerConsumersRequest {
4019
4392
  /**
4020
4393
  * <p>The tracker resource whose associated geofence collections you want to list.</p>
@@ -4034,6 +4407,9 @@ export interface ListTrackerConsumersRequest {
4034
4407
  */
4035
4408
  NextToken?: string;
4036
4409
  }
4410
+ /**
4411
+ * @public
4412
+ */
4037
4413
  export interface ListTrackerConsumersResponse {
4038
4414
  /**
4039
4415
  * <p>Contains the list of geofence collection ARNs associated to the tracker resource.</p>
@@ -4045,6 +4421,9 @@ export interface ListTrackerConsumersResponse {
4045
4421
  */
4046
4422
  NextToken?: string;
4047
4423
  }
4424
+ /**
4425
+ * @public
4426
+ */
4048
4427
  export interface ListTrackersRequest {
4049
4428
  /**
4050
4429
  * <p>An optional limit for the number of resources returned in a single call. </p>
@@ -4061,6 +4440,7 @@ export interface ListTrackersRequest {
4061
4440
  NextToken?: string;
4062
4441
  }
4063
4442
  /**
4443
+ * @public
4064
4444
  * <p>Contains the tracker resource details.</p>
4065
4445
  */
4066
4446
  export interface ListTrackersResponseEntry {
@@ -4095,6 +4475,9 @@ export interface ListTrackersResponseEntry {
4095
4475
  */
4096
4476
  UpdateTime: Date | undefined;
4097
4477
  }
4478
+ /**
4479
+ * @public
4480
+ */
4098
4481
  export interface ListTrackersResponse {
4099
4482
  /**
4100
4483
  * <p>Contains tracker resources in your Amazon Web Services account. Details include tracker name,
@@ -4107,6 +4490,9 @@ export interface ListTrackersResponse {
4107
4490
  */
4108
4491
  NextToken?: string;
4109
4492
  }
4493
+ /**
4494
+ * @public
4495
+ */
4110
4496
  export interface UpdateMapRequest {
4111
4497
  /**
4112
4498
  * <p>The name of the map resource to update.</p>
@@ -4124,6 +4510,9 @@ export interface UpdateMapRequest {
4124
4510
  */
4125
4511
  Description?: string;
4126
4512
  }
4513
+ /**
4514
+ * @public
4515
+ */
4127
4516
  export interface UpdateMapResponse {
4128
4517
  /**
4129
4518
  * <p>The name of the updated map resource.</p>
@@ -4146,6 +4535,9 @@ export interface UpdateMapResponse {
4146
4535
  */
4147
4536
  UpdateTime: Date | undefined;
4148
4537
  }
4538
+ /**
4539
+ * @public
4540
+ */
4149
4541
  export interface SearchPlaceIndexForPositionRequest {
4150
4542
  /**
4151
4543
  * <p>The name of the place index resource you want to use for the search.</p>
@@ -4185,6 +4577,7 @@ export interface SearchPlaceIndexForPositionRequest {
4185
4577
  Language?: string;
4186
4578
  }
4187
4579
  /**
4580
+ * @public
4188
4581
  * <p>Contains a search result from a position search query that is run on a place index
4189
4582
  * resource.</p>
4190
4583
  */
@@ -4213,6 +4606,7 @@ export interface SearchForPositionResult {
4213
4606
  PlaceId?: string;
4214
4607
  }
4215
4608
  /**
4609
+ * @public
4216
4610
  * <p>A summary of the request sent by using
4217
4611
  * <code>SearchPlaceIndexForPosition</code>.</p>
4218
4612
  */
@@ -4251,6 +4645,9 @@ export interface SearchPlaceIndexForPositionSummary {
4251
4645
  */
4252
4646
  Language?: string;
4253
4647
  }
4648
+ /**
4649
+ * @public
4650
+ */
4254
4651
  export interface SearchPlaceIndexForPositionResponse {
4255
4652
  /**
4256
4653
  * <p>Contains a summary of the request. Echoes the input values for <code>Position</code>,
@@ -4264,6 +4661,9 @@ export interface SearchPlaceIndexForPositionResponse {
4264
4661
  */
4265
4662
  Results: SearchForPositionResult[] | undefined;
4266
4663
  }
4664
+ /**
4665
+ * @public
4666
+ */
4267
4667
  export interface SearchPlaceIndexForSuggestionsRequest {
4268
4668
  /**
4269
4669
  * <p>The name of the place index resource you want to use for the search.</p>
@@ -4343,6 +4743,7 @@ export interface SearchPlaceIndexForSuggestionsRequest {
4343
4743
  Language?: string;
4344
4744
  }
4345
4745
  /**
4746
+ * @public
4346
4747
  * <p>Contains a place suggestion resulting from a place suggestion query that is run on a
4347
4748
  * place index resource.</p>
4348
4749
  */
@@ -4363,6 +4764,7 @@ export interface SearchForSuggestionsResult {
4363
4764
  PlaceId?: string;
4364
4765
  }
4365
4766
  /**
4767
+ * @public
4366
4768
  * <p>A summary of the request sent by using
4367
4769
  * <code>SearchPlaceIndexForSuggestions</code>.</p>
4368
4770
  */
@@ -4418,6 +4820,9 @@ export interface SearchPlaceIndexForSuggestionsSummary {
4418
4820
  */
4419
4821
  Language?: string;
4420
4822
  }
4823
+ /**
4824
+ * @public
4825
+ */
4421
4826
  export interface SearchPlaceIndexForSuggestionsResponse {
4422
4827
  /**
4423
4828
  * <p>Contains a summary of the request. Echoes the input values for
@@ -4431,6 +4836,9 @@ export interface SearchPlaceIndexForSuggestionsResponse {
4431
4836
  */
4432
4837
  Results: SearchForSuggestionsResult[] | undefined;
4433
4838
  }
4839
+ /**
4840
+ * @public
4841
+ */
4434
4842
  export interface SearchPlaceIndexForTextRequest {
4435
4843
  /**
4436
4844
  * <p>The name of the place index resource you want to use for the search.</p>
@@ -4510,6 +4918,7 @@ export interface SearchPlaceIndexForTextRequest {
4510
4918
  Language?: string;
4511
4919
  }
4512
4920
  /**
4921
+ * @public
4513
4922
  * <p>Contains a search result from a text search query that is run on a place index
4514
4923
  * resource.</p>
4515
4924
  */
@@ -4546,6 +4955,7 @@ export interface SearchForTextResult {
4546
4955
  PlaceId?: string;
4547
4956
  }
4548
4957
  /**
4958
+ * @public
4549
4959
  * <p>A summary of the request sent by using <code>SearchPlaceIndexForText</code>.</p>
4550
4960
  */
4551
4961
  export interface SearchPlaceIndexForTextSummary {
@@ -4608,6 +5018,9 @@ export interface SearchPlaceIndexForTextSummary {
4608
5018
  */
4609
5019
  Language?: string;
4610
5020
  }
5021
+ /**
5022
+ * @public
5023
+ */
4611
5024
  export interface SearchPlaceIndexForTextResponse {
4612
5025
  /**
4613
5026
  * <p>Contains a summary of the request. Echoes the input values for
@@ -4625,6 +5038,9 @@ export interface SearchPlaceIndexForTextResponse {
4625
5038
  */
4626
5039
  Results: SearchForTextResult[] | undefined;
4627
5040
  }
5041
+ /**
5042
+ * @public
5043
+ */
4628
5044
  export interface UpdatePlaceIndexRequest {
4629
5045
  /**
4630
5046
  * <p>The name of the place index resource to update.</p>
@@ -4646,6 +5062,9 @@ export interface UpdatePlaceIndexRequest {
4646
5062
  */
4647
5063
  DataSourceConfiguration?: DataSourceConfiguration;
4648
5064
  }
5065
+ /**
5066
+ * @public
5067
+ */
4649
5068
  export interface UpdatePlaceIndexResponse {
4650
5069
  /**
4651
5070
  * <p>The name of the updated place index resource.</p>
@@ -4669,6 +5088,9 @@ export interface UpdatePlaceIndexResponse {
4669
5088
  */
4670
5089
  UpdateTime: Date | undefined;
4671
5090
  }
5091
+ /**
5092
+ * @public
5093
+ */
4672
5094
  export interface UpdateRouteCalculatorRequest {
4673
5095
  /**
4674
5096
  * <p>The name of the route calculator resource to update.</p>
@@ -4686,6 +5108,9 @@ export interface UpdateRouteCalculatorRequest {
4686
5108
  */
4687
5109
  Description?: string;
4688
5110
  }
5111
+ /**
5112
+ * @public
5113
+ */
4689
5114
  export interface UpdateRouteCalculatorResponse {
4690
5115
  /**
4691
5116
  * <p>The name of the updated route calculator resource.</p>
@@ -4709,6 +5134,9 @@ export interface UpdateRouteCalculatorResponse {
4709
5134
  */
4710
5135
  UpdateTime: Date | undefined;
4711
5136
  }
5137
+ /**
5138
+ * @public
5139
+ */
4712
5140
  export interface UpdateTrackerRequest {
4713
5141
  /**
4714
5142
  * <p>The name of the tracker resource to update.</p>
@@ -4765,6 +5193,9 @@ export interface UpdateTrackerRequest {
4765
5193
  */
4766
5194
  PositionFiltering?: PositionFiltering | string;
4767
5195
  }
5196
+ /**
5197
+ * @public
5198
+ */
4768
5199
  export interface UpdateTrackerResponse {
4769
5200
  /**
4770
5201
  * <p>The name of the updated tracker resource.</p>