@aws-sdk/client-location 3.378.0 → 3.382.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.
@@ -24,6 +24,7 @@ export type Status = "Active" | "Expired";
24
24
  */
25
25
  export interface ApiKeyFilter {
26
26
  /**
27
+ * @public
27
28
  * <p>Filter on <code>Active</code> or <code>Expired</code> API keys.</p>
28
29
  */
29
30
  KeyStatus?: Status | string;
@@ -48,6 +49,7 @@ export declare class ConflictException extends __BaseException {
48
49
  */
49
50
  export interface ApiKeyRestrictions {
50
51
  /**
52
+ * @public
51
53
  * <p>A list of allowed actions that an API key resource grants permissions to
52
54
  * perform. You must have at least one action for each type of resource. For example,
53
55
  * if you have a place resource, you must include at least one place action.</p>
@@ -117,6 +119,7 @@ export interface ApiKeyRestrictions {
117
119
  */
118
120
  AllowActions: string[] | undefined;
119
121
  /**
122
+ * @public
120
123
  * <p>A list of allowed resource ARNs that a API key bearer can perform actions on.</p>
121
124
  * <ul>
122
125
  * <li>
@@ -145,6 +148,7 @@ export interface ApiKeyRestrictions {
145
148
  */
146
149
  AllowResources: string[] | undefined;
147
150
  /**
151
+ * @public
148
152
  * <p>An optional list of allowed HTTP referers for which requests must originate from.
149
153
  * Requests using this API key from other domains will not be allowed.</p>
150
154
  * <p>Requirements:</p>
@@ -177,6 +181,7 @@ export interface ApiKeyRestrictions {
177
181
  */
178
182
  export interface CreateKeyRequest {
179
183
  /**
184
+ * @public
180
185
  * <p>A custom name for the API key resource.</p>
181
186
  * <p>Requirements:</p>
182
187
  * <ul>
@@ -194,25 +199,30 @@ export interface CreateKeyRequest {
194
199
  */
195
200
  KeyName: string | undefined;
196
201
  /**
202
+ * @public
197
203
  * <p>The API key restrictions for the API key resource.</p>
198
204
  */
199
205
  Restrictions: ApiKeyRestrictions | undefined;
200
206
  /**
207
+ * @public
201
208
  * <p>An optional description for the API key resource.</p>
202
209
  */
203
210
  Description?: string;
204
211
  /**
212
+ * @public
205
213
  * <p>The optional timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
206
214
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. One of <code>NoExpiry</code> or
207
215
  * <code>ExpireTime</code> must be set.</p>
208
216
  */
209
217
  ExpireTime?: Date;
210
218
  /**
219
+ * @public
211
220
  * <p>Optionally set to <code>true</code> to set no expiration time for the API key. One of
212
221
  * <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
213
222
  */
214
223
  NoExpiry?: boolean;
215
224
  /**
225
+ * @public
216
226
  * <p>Applies one or more tags to the map resource. A tag is a key-value pair that helps
217
227
  * manage, identify, search, and filter your resources by labelling them.</p>
218
228
  * <p>Format: <code>"key" : "value"</code>
@@ -247,11 +257,13 @@ export interface CreateKeyRequest {
247
257
  */
248
258
  export interface CreateKeyResponse {
249
259
  /**
260
+ * @public
250
261
  * <p>The key value/string of an API key. This value is used when making API calls to
251
262
  * authorize the call. For example, see <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_GetMapGlyphs.html">GetMapGlyphs</a>.</p>
252
263
  */
253
264
  Key: string | undefined;
254
265
  /**
266
+ * @public
255
267
  * <p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify
256
268
  * a resource across all Amazon Web Services.</p>
257
269
  * <ul>
@@ -264,10 +276,12 @@ export interface CreateKeyResponse {
264
276
  */
265
277
  KeyArn: string | undefined;
266
278
  /**
279
+ * @public
267
280
  * <p>The name of the API key resource.</p>
268
281
  */
269
282
  KeyName: string | undefined;
270
283
  /**
284
+ * @public
271
285
  * <p>The timestamp for when the API key resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
272
286
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
273
287
  */
@@ -296,6 +310,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
296
310
  readonly name: "ServiceQuotaExceededException";
297
311
  readonly $fault: "client";
298
312
  /**
313
+ * @public
299
314
  * <p>A message with the reason for the service quota exceeded exception error.</p>
300
315
  */
301
316
  Message: string | undefined;
@@ -325,10 +340,12 @@ export declare class ThrottlingException extends __BaseException {
325
340
  */
326
341
  export interface ValidationExceptionField {
327
342
  /**
343
+ * @public
328
344
  * <p>The field name where the invalid entry was detected.</p>
329
345
  */
330
346
  Name: string | undefined;
331
347
  /**
348
+ * @public
332
349
  * <p>A message with the reason for the validation exception error.</p>
333
350
  */
334
351
  Message: string | undefined;
@@ -346,10 +363,12 @@ export declare class ValidationException extends __BaseException {
346
363
  readonly $fault: "client";
347
364
  Message: string | undefined;
348
365
  /**
366
+ * @public
349
367
  * <p>A message with the reason for the validation exception error.</p>
350
368
  */
351
369
  Reason: ValidationExceptionReason | string | undefined;
352
370
  /**
371
+ * @public
353
372
  * <p>The field where the invalid entry was detected.</p>
354
373
  */
355
374
  FieldList: ValidationExceptionField[] | undefined;
@@ -363,6 +382,7 @@ export declare class ValidationException extends __BaseException {
363
382
  */
364
383
  export interface DeleteKeyRequest {
365
384
  /**
385
+ * @public
366
386
  * <p>The name of the API key to delete.</p>
367
387
  */
368
388
  KeyName: string | undefined;
@@ -390,6 +410,7 @@ export declare class ResourceNotFoundException extends __BaseException {
390
410
  */
391
411
  export interface DescribeKeyRequest {
392
412
  /**
413
+ * @public
393
414
  * <p>The name of the API key resource.</p>
394
415
  */
395
416
  KeyName: string | undefined;
@@ -399,10 +420,12 @@ export interface DescribeKeyRequest {
399
420
  */
400
421
  export interface DescribeKeyResponse {
401
422
  /**
423
+ * @public
402
424
  * <p>The key value/string of an API key.</p>
403
425
  */
404
426
  Key: string | undefined;
405
427
  /**
428
+ * @public
406
429
  * <p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify
407
430
  * a resource across all Amazon Web Services.</p>
408
431
  * <ul>
@@ -415,34 +438,41 @@ export interface DescribeKeyResponse {
415
438
  */
416
439
  KeyArn: string | undefined;
417
440
  /**
441
+ * @public
418
442
  * <p>The name of the API key resource.</p>
419
443
  */
420
444
  KeyName: string | undefined;
421
445
  /**
446
+ * @public
422
447
  * <p>API Restrictions on the allowed actions, resources, and referers for an API key
423
448
  * resource.</p>
424
449
  */
425
450
  Restrictions: ApiKeyRestrictions | undefined;
426
451
  /**
452
+ * @public
427
453
  * <p>The timestamp for when the API key resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
428
454
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
429
455
  */
430
456
  CreateTime: Date | undefined;
431
457
  /**
458
+ * @public
432
459
  * <p>The timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
433
460
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
434
461
  */
435
462
  ExpireTime: Date | undefined;
436
463
  /**
464
+ * @public
437
465
  * <p>The timestamp for when the API key resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
438
466
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
439
467
  */
440
468
  UpdateTime: Date | undefined;
441
469
  /**
470
+ * @public
442
471
  * <p>The optional description for the API key resource.</p>
443
472
  */
444
473
  Description?: string;
445
474
  /**
475
+ * @public
446
476
  * <p>Tags associated with the API key resource.</p>
447
477
  */
448
478
  Tags?: Record<string, string>;
@@ -452,12 +482,14 @@ export interface DescribeKeyResponse {
452
482
  */
453
483
  export interface ListKeysRequest {
454
484
  /**
485
+ * @public
455
486
  * <p>An optional limit for the number of resources returned in a single call. </p>
456
487
  * <p>Default value: <code>100</code>
457
488
  * </p>
458
489
  */
459
490
  MaxResults?: number;
460
491
  /**
492
+ * @public
461
493
  * <p>The pagination token specifying which page of results to return in the response. If no
462
494
  * token is provided, the default page is the first page. </p>
463
495
  * <p>Default value: <code>null</code>
@@ -465,6 +497,7 @@ export interface ListKeysRequest {
465
497
  */
466
498
  NextToken?: string;
467
499
  /**
500
+ * @public
468
501
  * <p>Optionally filter the list to only <code>Active</code> or <code>Expired</code> API
469
502
  * keys.</p>
470
503
  */
@@ -476,29 +509,35 @@ export interface ListKeysRequest {
476
509
  */
477
510
  export interface ListKeysResponseEntry {
478
511
  /**
512
+ * @public
479
513
  * <p>The name of the API key resource.</p>
480
514
  */
481
515
  KeyName: string | undefined;
482
516
  /**
517
+ * @public
483
518
  * <p>The timestamp for when the API key resource will expire, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
484
519
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
485
520
  */
486
521
  ExpireTime: Date | undefined;
487
522
  /**
523
+ * @public
488
524
  * <p>The optional description for the API key resource.</p>
489
525
  */
490
526
  Description?: string;
491
527
  /**
528
+ * @public
492
529
  * <p>API Restrictions on the allowed actions, resources, and referers for an API key
493
530
  * resource.</p>
494
531
  */
495
532
  Restrictions: ApiKeyRestrictions | undefined;
496
533
  /**
534
+ * @public
497
535
  * <p>The timestamp of when the API key was created, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
498
536
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
499
537
  */
500
538
  CreateTime: Date | undefined;
501
539
  /**
540
+ * @public
502
541
  * <p>The timestamp of when the API key was last updated, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
503
542
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
504
543
  */
@@ -509,11 +548,13 @@ export interface ListKeysResponseEntry {
509
548
  */
510
549
  export interface ListKeysResponse {
511
550
  /**
551
+ * @public
512
552
  * <p>Contains API key resources in your Amazon Web Services account. Details include API key
513
553
  * name, allowed referers and timestamp for when the API key will expire.</p>
514
554
  */
515
555
  Entries: ListKeysResponseEntry[] | undefined;
516
556
  /**
557
+ * @public
517
558
  * <p>A pagination token indicating there are additional pages available. You can use the
518
559
  * token in a following request to fetch the next set of results. </p>
519
560
  */
@@ -524,24 +565,29 @@ export interface ListKeysResponse {
524
565
  */
525
566
  export interface UpdateKeyRequest {
526
567
  /**
568
+ * @public
527
569
  * <p>The name of the API key resource to update.</p>
528
570
  */
529
571
  KeyName: string | undefined;
530
572
  /**
573
+ * @public
531
574
  * <p>Updates the description for the API key resource.</p>
532
575
  */
533
576
  Description?: string;
534
577
  /**
578
+ * @public
535
579
  * <p>Updates the timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
536
580
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
537
581
  */
538
582
  ExpireTime?: Date;
539
583
  /**
584
+ * @public
540
585
  * <p>Whether the API key should expire. Set to <code>true</code> to set the API key to have
541
586
  * no expiration time.</p>
542
587
  */
543
588
  NoExpiry?: boolean;
544
589
  /**
590
+ * @public
545
591
  * <p>The boolean flag to be included for updating <code>ExpireTime</code> or
546
592
  * <code>Restrictions</code> details.</p>
547
593
  * <p>Must be set to <code>true</code> to update an API key resource that has been used in
@@ -553,6 +599,7 @@ export interface UpdateKeyRequest {
553
599
  */
554
600
  ForceUpdate?: boolean;
555
601
  /**
602
+ * @public
556
603
  * <p>Updates the API key restrictions for the API key resource.</p>
557
604
  */
558
605
  Restrictions?: ApiKeyRestrictions;
@@ -562,6 +609,7 @@ export interface UpdateKeyRequest {
562
609
  */
563
610
  export interface UpdateKeyResponse {
564
611
  /**
612
+ * @public
565
613
  * <p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify
566
614
  * a resource across all Amazon Web Services.</p>
567
615
  * <ul>
@@ -574,10 +622,12 @@ export interface UpdateKeyResponse {
574
622
  */
575
623
  KeyArn: string | undefined;
576
624
  /**
625
+ * @public
577
626
  * <p>The name of the API key resource.</p>
578
627
  */
579
628
  KeyName: string | undefined;
580
629
  /**
630
+ * @public
581
631
  * <p>The timestamp for when the API key resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
582
632
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
583
633
  */
@@ -588,10 +638,12 @@ export interface UpdateKeyResponse {
588
638
  */
589
639
  export interface AssociateTrackerConsumerRequest {
590
640
  /**
641
+ * @public
591
642
  * <p>The name of the tracker resource to be associated with a geofence collection.</p>
592
643
  */
593
644
  TrackerName: string | undefined;
594
645
  /**
646
+ * @public
595
647
  * <p>The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker
596
648
  * resource. Used when you need to specify a resource across all Amazon Web Services.</p>
597
649
  * <ul>
@@ -614,10 +666,12 @@ export interface AssociateTrackerConsumerResponse {
614
666
  */
615
667
  export interface BatchDeleteDevicePositionHistoryRequest {
616
668
  /**
669
+ * @public
617
670
  * <p>The name of the tracker resource to delete the device position history from.</p>
618
671
  */
619
672
  TrackerName: string | undefined;
620
673
  /**
674
+ * @public
621
675
  * <p>Devices whose position history you want to delete.</p>
622
676
  * <ul>
623
677
  * <li>
@@ -639,10 +693,12 @@ export type BatchItemErrorCode = "AccessDeniedError" | "ConflictError" | "Intern
639
693
  */
640
694
  export interface BatchItemError {
641
695
  /**
696
+ * @public
642
697
  * <p>The error code associated with the batch request error.</p>
643
698
  */
644
699
  Code?: BatchItemErrorCode | string;
645
700
  /**
701
+ * @public
646
702
  * <p>A message with the reason for the batch request error.</p>
647
703
  */
648
704
  Message?: string;
@@ -653,10 +709,12 @@ export interface BatchItemError {
653
709
  */
654
710
  export interface BatchDeleteDevicePositionHistoryError {
655
711
  /**
712
+ * @public
656
713
  * <p>The ID of the device for this position.</p>
657
714
  */
658
715
  DeviceId: string | undefined;
659
716
  /**
717
+ * @public
660
718
  * <p>Contains the batch request error details associated with the request.</p>
661
719
  */
662
720
  Error: BatchItemError | undefined;
@@ -666,6 +724,7 @@ export interface BatchDeleteDevicePositionHistoryError {
666
724
  */
667
725
  export interface BatchDeleteDevicePositionHistoryResponse {
668
726
  /**
727
+ * @public
669
728
  * <p>Contains error details for each device history that failed to delete.</p>
670
729
  */
671
730
  Errors: BatchDeleteDevicePositionHistoryError[] | undefined;
@@ -675,10 +734,12 @@ export interface BatchDeleteDevicePositionHistoryResponse {
675
734
  */
676
735
  export interface BatchDeleteGeofenceRequest {
677
736
  /**
737
+ * @public
678
738
  * <p>The geofence collection storing the geofences to be deleted.</p>
679
739
  */
680
740
  CollectionName: string | undefined;
681
741
  /**
742
+ * @public
682
743
  * <p>The batch of geofences to be deleted.</p>
683
744
  */
684
745
  GeofenceIds: string[] | undefined;
@@ -690,10 +751,12 @@ export interface BatchDeleteGeofenceRequest {
690
751
  */
691
752
  export interface BatchDeleteGeofenceError {
692
753
  /**
754
+ * @public
693
755
  * <p>The geofence associated with the error message.</p>
694
756
  */
695
757
  GeofenceId: string | undefined;
696
758
  /**
759
+ * @public
697
760
  * <p>Contains details associated to the batch error.</p>
698
761
  */
699
762
  Error: BatchItemError | undefined;
@@ -703,6 +766,7 @@ export interface BatchDeleteGeofenceError {
703
766
  */
704
767
  export interface BatchDeleteGeofenceResponse {
705
768
  /**
769
+ * @public
706
770
  * <p>Contains error details for each geofence that failed to delete.</p>
707
771
  */
708
772
  Errors: BatchDeleteGeofenceError[] | undefined;
@@ -713,6 +777,7 @@ export interface BatchDeleteGeofenceResponse {
713
777
  */
714
778
  export interface PositionalAccuracy {
715
779
  /**
780
+ * @public
716
781
  * <p>Estimated maximum distance, in meters, between the measured position and the true
717
782
  * position of a device, along the Earth's surface.</p>
718
783
  */
@@ -724,25 +789,30 @@ export interface PositionalAccuracy {
724
789
  */
725
790
  export interface DevicePositionUpdate {
726
791
  /**
792
+ * @public
727
793
  * <p>The device associated to the position update.</p>
728
794
  */
729
795
  DeviceId: string | undefined;
730
796
  /**
797
+ * @public
731
798
  * <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
732
799
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
733
800
  * </p>
734
801
  */
735
802
  SampleTime: Date | undefined;
736
803
  /**
804
+ * @public
737
805
  * <p>The latest device position defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84">WGS 84</a> format:
738
806
  * <code>[X or longitude, Y or latitude]</code>.</p>
739
807
  */
740
808
  Position: number[] | undefined;
741
809
  /**
810
+ * @public
742
811
  * <p>The accuracy of the device position.</p>
743
812
  */
744
813
  Accuracy?: PositionalAccuracy;
745
814
  /**
815
+ * @public
746
816
  * <p>Associates one of more properties with the position update. A property is a key-value
747
817
  * pair stored with the position update and added to any geofence event the update may
748
818
  * trigger.</p>
@@ -756,11 +826,13 @@ export interface DevicePositionUpdate {
756
826
  */
757
827
  export interface BatchEvaluateGeofencesRequest {
758
828
  /**
829
+ * @public
759
830
  * <p>The geofence collection used in evaluating the position of devices against its
760
831
  * geofences.</p>
761
832
  */
762
833
  CollectionName: string | undefined;
763
834
  /**
835
+ * @public
764
836
  * <p>Contains device details for each device to be evaluated against the given geofence
765
837
  * collection.</p>
766
838
  */
@@ -773,16 +845,19 @@ export interface BatchEvaluateGeofencesRequest {
773
845
  */
774
846
  export interface BatchEvaluateGeofencesError {
775
847
  /**
848
+ * @public
776
849
  * <p>The device associated with the position evaluation error.</p>
777
850
  */
778
851
  DeviceId: string | undefined;
779
852
  /**
853
+ * @public
780
854
  * <p>Specifies a timestamp for when the error occurred in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
781
855
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
782
856
  * </p>
783
857
  */
784
858
  SampleTime: Date | undefined;
785
859
  /**
860
+ * @public
786
861
  * <p>Contains details associated to the batch error.</p>
787
862
  */
788
863
  Error: BatchItemError | undefined;
@@ -792,6 +867,7 @@ export interface BatchEvaluateGeofencesError {
792
867
  */
793
868
  export interface BatchEvaluateGeofencesResponse {
794
869
  /**
870
+ * @public
795
871
  * <p>Contains error details for each device that failed to evaluate its position against
796
872
  * the given geofence collection.</p>
797
873
  */
@@ -802,10 +878,12 @@ export interface BatchEvaluateGeofencesResponse {
802
878
  */
803
879
  export interface BatchGetDevicePositionRequest {
804
880
  /**
881
+ * @public
805
882
  * <p>The tracker resource retrieving the device position.</p>
806
883
  */
807
884
  TrackerName: string | undefined;
808
885
  /**
886
+ * @public
809
887
  * <p>Devices whose position you want to retrieve.</p>
810
888
  * <ul>
811
889
  * <li>
@@ -823,28 +901,34 @@ export interface BatchGetDevicePositionRequest {
823
901
  */
824
902
  export interface DevicePosition {
825
903
  /**
904
+ * @public
826
905
  * <p>The device whose position you retrieved.</p>
827
906
  */
828
907
  DeviceId?: string;
829
908
  /**
909
+ * @public
830
910
  * <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
831
911
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
832
912
  */
833
913
  SampleTime: Date | undefined;
834
914
  /**
915
+ * @public
835
916
  * <p>The timestamp for when the tracker resource received the device position in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
836
917
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
837
918
  */
838
919
  ReceivedTime: Date | undefined;
839
920
  /**
921
+ * @public
840
922
  * <p>The last known device position.</p>
841
923
  */
842
924
  Position: number[] | undefined;
843
925
  /**
926
+ * @public
844
927
  * <p>The accuracy of the device position.</p>
845
928
  */
846
929
  Accuracy?: PositionalAccuracy;
847
930
  /**
931
+ * @public
848
932
  * <p>The properties associated with the position.</p>
849
933
  */
850
934
  PositionProperties?: Record<string, string>;
@@ -855,10 +939,12 @@ export interface DevicePosition {
855
939
  */
856
940
  export interface BatchGetDevicePositionError {
857
941
  /**
942
+ * @public
858
943
  * <p>The ID of the device that didn't return a position.</p>
859
944
  */
860
945
  DeviceId: string | undefined;
861
946
  /**
947
+ * @public
862
948
  * <p>Contains details related to the error code.</p>
863
949
  */
864
950
  Error: BatchItemError | undefined;
@@ -868,11 +954,13 @@ export interface BatchGetDevicePositionError {
868
954
  */
869
955
  export interface BatchGetDevicePositionResponse {
870
956
  /**
957
+ * @public
871
958
  * <p>Contains error details for each device that failed to send its position to the tracker
872
959
  * resource.</p>
873
960
  */
874
961
  Errors: BatchGetDevicePositionError[] | undefined;
875
962
  /**
963
+ * @public
876
964
  * <p>Contains device position details such as the device ID, position, and timestamps for
877
965
  * when the position was received and sampled.</p>
878
966
  */
@@ -884,11 +972,13 @@ export interface BatchGetDevicePositionResponse {
884
972
  */
885
973
  export interface Circle {
886
974
  /**
975
+ * @public
887
976
  * <p>A single point geometry, specifying the center of the circle, using <a href="https://gisgeography.com/wgs84-world-geodetic-system/">WGS 84</a>
888
977
  * coordinates, in the form <code>[longitude, latitude]</code>.</p>
889
978
  */
890
979
  Center: number[] | undefined;
891
980
  /**
981
+ * @public
892
982
  * <p>The radius of the circle in meters. Must be greater than zero and no
893
983
  * larger than 100,000 (100 kilometers).</p>
894
984
  */
@@ -906,6 +996,7 @@ export interface Circle {
906
996
  */
907
997
  export interface GeofenceGeometry {
908
998
  /**
999
+ * @public
909
1000
  * <p>A polygon is a list of linear rings which are each made up of a list of
910
1001
  * vertices.</p>
911
1002
  * <p>Each vertex is a 2-dimensional point of the form: <code>[longitude, latitude]</code>.
@@ -922,6 +1013,7 @@ export interface GeofenceGeometry {
922
1013
  */
923
1014
  Polygon?: number[][][];
924
1015
  /**
1016
+ * @public
925
1017
  * <p>A circle on the earth, as defined by a center point and a radius.</p>
926
1018
  */
927
1019
  Circle?: Circle;
@@ -932,10 +1024,12 @@ export interface GeofenceGeometry {
932
1024
  */
933
1025
  export interface BatchPutGeofenceRequestEntry {
934
1026
  /**
1027
+ * @public
935
1028
  * <p>The identifier for the geofence to be stored in a given geofence collection.</p>
936
1029
  */
937
1030
  GeofenceId: string | undefined;
938
1031
  /**
1032
+ * @public
939
1033
  * <p>Contains the details of the position of the geofence. Can be either a
940
1034
  * polygon or a circle. Including both will return a validation error.</p>
941
1035
  * <note>
@@ -945,6 +1039,7 @@ export interface BatchPutGeofenceRequestEntry {
945
1039
  */
946
1040
  Geometry: GeofenceGeometry | undefined;
947
1041
  /**
1042
+ * @public
948
1043
  * <p>Associates one of more properties with the geofence. A property is a key-value
949
1044
  * pair stored with the geofence and added to any geofence event triggered with that
950
1045
  * geofence.</p>
@@ -958,10 +1053,12 @@ export interface BatchPutGeofenceRequestEntry {
958
1053
  */
959
1054
  export interface BatchPutGeofenceRequest {
960
1055
  /**
1056
+ * @public
961
1057
  * <p>The geofence collection storing the geofences.</p>
962
1058
  */
963
1059
  CollectionName: string | undefined;
964
1060
  /**
1061
+ * @public
965
1062
  * <p>The batch of geofences to be stored in a geofence collection.</p>
966
1063
  */
967
1064
  Entries: BatchPutGeofenceRequestEntry[] | undefined;
@@ -973,10 +1070,12 @@ export interface BatchPutGeofenceRequest {
973
1070
  */
974
1071
  export interface BatchPutGeofenceError {
975
1072
  /**
1073
+ * @public
976
1074
  * <p>The geofence associated with the error message.</p>
977
1075
  */
978
1076
  GeofenceId: string | undefined;
979
1077
  /**
1078
+ * @public
980
1079
  * <p>Contains details associated to the batch error.</p>
981
1080
  */
982
1081
  Error: BatchItemError | undefined;
@@ -988,16 +1087,19 @@ export interface BatchPutGeofenceError {
988
1087
  */
989
1088
  export interface BatchPutGeofenceSuccess {
990
1089
  /**
1090
+ * @public
991
1091
  * <p>The geofence successfully stored in a geofence collection.</p>
992
1092
  */
993
1093
  GeofenceId: string | undefined;
994
1094
  /**
1095
+ * @public
995
1096
  * <p>The timestamp for when the geofence was stored in a geofence collection in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
996
1097
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
997
1098
  * </p>
998
1099
  */
999
1100
  CreateTime: Date | undefined;
1000
1101
  /**
1102
+ * @public
1001
1103
  * <p>The timestamp for when the geofence was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
1002
1104
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
1003
1105
  * </p>
@@ -1009,10 +1111,12 @@ export interface BatchPutGeofenceSuccess {
1009
1111
  */
1010
1112
  export interface BatchPutGeofenceResponse {
1011
1113
  /**
1114
+ * @public
1012
1115
  * <p>Contains each geofence that was successfully stored in a geofence collection.</p>
1013
1116
  */
1014
1117
  Successes: BatchPutGeofenceSuccess[] | undefined;
1015
1118
  /**
1119
+ * @public
1016
1120
  * <p>Contains additional error details for each geofence that failed to be stored in a
1017
1121
  * geofence collection.</p>
1018
1122
  */
@@ -1023,10 +1127,12 @@ export interface BatchPutGeofenceResponse {
1023
1127
  */
1024
1128
  export interface BatchUpdateDevicePositionRequest {
1025
1129
  /**
1130
+ * @public
1026
1131
  * <p>The name of the tracker resource to update.</p>
1027
1132
  */
1028
1133
  TrackerName: string | undefined;
1029
1134
  /**
1135
+ * @public
1030
1136
  * <p>Contains the position update details for each device, up to 10 devices.</p>
1031
1137
  */
1032
1138
  Updates: DevicePositionUpdate[] | undefined;
@@ -1037,15 +1143,18 @@ export interface BatchUpdateDevicePositionRequest {
1037
1143
  */
1038
1144
  export interface BatchUpdateDevicePositionError {
1039
1145
  /**
1146
+ * @public
1040
1147
  * <p>The device associated with the failed location update.</p>
1041
1148
  */
1042
1149
  DeviceId: string | undefined;
1043
1150
  /**
1151
+ * @public
1044
1152
  * <p>The timestamp at which the device position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
1045
1153
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
1046
1154
  */
1047
1155
  SampleTime: Date | undefined;
1048
1156
  /**
1157
+ * @public
1049
1158
  * <p>Contains details related to the error code such as the error code and error
1050
1159
  * message.</p>
1051
1160
  */
@@ -1056,6 +1165,7 @@ export interface BatchUpdateDevicePositionError {
1056
1165
  */
1057
1166
  export interface BatchUpdateDevicePositionResponse {
1058
1167
  /**
1168
+ * @public
1059
1169
  * <p>Contains error details for each device that failed to update its position.</p>
1060
1170
  */
1061
1171
  Errors: BatchUpdateDevicePositionError[] | undefined;
@@ -1067,6 +1177,7 @@ export interface BatchUpdateDevicePositionResponse {
1067
1177
  */
1068
1178
  export interface CalculateRouteCarModeOptions {
1069
1179
  /**
1180
+ * @public
1070
1181
  * <p>Avoids ferries when calculating routes.</p>
1071
1182
  * <p>Default Value: <code>false</code>
1072
1183
  * </p>
@@ -1075,6 +1186,7 @@ export interface CalculateRouteCarModeOptions {
1075
1186
  */
1076
1187
  AvoidFerries?: boolean;
1077
1188
  /**
1189
+ * @public
1078
1190
  * <p>Avoids tolls when calculating routes.</p>
1079
1191
  * <p>Default Value: <code>false</code>
1080
1192
  * </p>
@@ -1103,6 +1215,7 @@ export type DimensionUnit = "Feet" | "Meters";
1103
1215
  */
1104
1216
  export interface TruckDimensions {
1105
1217
  /**
1218
+ * @public
1106
1219
  * <p>The length of the truck.</p>
1107
1220
  * <ul>
1108
1221
  * <li>
@@ -1117,6 +1230,7 @@ export interface TruckDimensions {
1117
1230
  */
1118
1231
  Length?: number;
1119
1232
  /**
1233
+ * @public
1120
1234
  * <p>The height of the truck.</p>
1121
1235
  * <ul>
1122
1236
  * <li>
@@ -1131,6 +1245,7 @@ export interface TruckDimensions {
1131
1245
  */
1132
1246
  Height?: number;
1133
1247
  /**
1248
+ * @public
1134
1249
  * <p>The width of the truck.</p>
1135
1250
  * <ul>
1136
1251
  * <li>
@@ -1145,6 +1260,7 @@ export interface TruckDimensions {
1145
1260
  */
1146
1261
  Width?: number;
1147
1262
  /**
1263
+ * @public
1148
1264
  * <p> Specifies the unit of measurement for the truck dimensions.</p>
1149
1265
  * <p>Default Value: <code>Meters</code>
1150
1266
  * </p>
@@ -1163,6 +1279,7 @@ export type VehicleWeightUnit = "Kilograms" | "Pounds";
1163
1279
  */
1164
1280
  export interface TruckWeight {
1165
1281
  /**
1282
+ * @public
1166
1283
  * <p>The total weight of the truck. </p>
1167
1284
  * <ul>
1168
1285
  * <li>
@@ -1172,6 +1289,7 @@ export interface TruckWeight {
1172
1289
  */
1173
1290
  Total?: number;
1174
1291
  /**
1292
+ * @public
1175
1293
  * <p>The unit of measurement to use for the truck weight.</p>
1176
1294
  * <p>Default Value: <code>Kilograms</code>
1177
1295
  * </p>
@@ -1185,6 +1303,7 @@ export interface TruckWeight {
1185
1303
  */
1186
1304
  export interface CalculateRouteTruckModeOptions {
1187
1305
  /**
1306
+ * @public
1188
1307
  * <p>Avoids ferries when calculating routes.</p>
1189
1308
  * <p>Default Value: <code>false</code>
1190
1309
  * </p>
@@ -1193,6 +1312,7 @@ export interface CalculateRouteTruckModeOptions {
1193
1312
  */
1194
1313
  AvoidFerries?: boolean;
1195
1314
  /**
1315
+ * @public
1196
1316
  * <p>Avoids tolls when calculating routes.</p>
1197
1317
  * <p>Default Value: <code>false</code>
1198
1318
  * </p>
@@ -1201,12 +1321,14 @@ export interface CalculateRouteTruckModeOptions {
1201
1321
  */
1202
1322
  AvoidTolls?: boolean;
1203
1323
  /**
1324
+ * @public
1204
1325
  * <p>Specifies the truck's dimension specifications including length, height, width, and
1205
1326
  * unit of measurement. Used to avoid roads that can't support the truck's
1206
1327
  * dimensions.</p>
1207
1328
  */
1208
1329
  Dimensions?: TruckDimensions;
1209
1330
  /**
1331
+ * @public
1210
1332
  * <p>Specifies the truck's weight specifications including total weight and unit of
1211
1333
  * measurement. Used to avoid roads that can't support the truck's weight.</p>
1212
1334
  */
@@ -1217,11 +1339,13 @@ export interface CalculateRouteTruckModeOptions {
1217
1339
  */
1218
1340
  export interface CalculateRouteRequest {
1219
1341
  /**
1342
+ * @public
1220
1343
  * <p>The name of the route calculator resource that you want to use to calculate the route.
1221
1344
  * </p>
1222
1345
  */
1223
1346
  CalculatorName: string | undefined;
1224
1347
  /**
1348
+ * @public
1225
1349
  * <p>The start position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84">World Geodetic
1226
1350
  * System (WGS 84)</a> format:
1227
1351
  * <code>[longitude, latitude]</code>.</p>
@@ -1242,6 +1366,7 @@ export interface CalculateRouteRequest {
1242
1366
  */
1243
1367
  DeparturePosition: number[] | undefined;
1244
1368
  /**
1369
+ * @public
1245
1370
  * <p>The finish position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84">World Geodetic
1246
1371
  * System (WGS 84)</a> format:
1247
1372
  * <code>[longitude, latitude]</code>.</p>
@@ -1260,6 +1385,7 @@ export interface CalculateRouteRequest {
1260
1385
  */
1261
1386
  DestinationPosition: number[] | undefined;
1262
1387
  /**
1388
+ * @public
1263
1389
  * <p>Specifies an ordered list of up to 23 intermediate positions to include along a route
1264
1390
  * between the departure position and destination position. </p>
1265
1391
  * <ul>
@@ -1284,6 +1410,7 @@ export interface CalculateRouteRequest {
1284
1410
  */
1285
1411
  WaypointPositions?: number[][];
1286
1412
  /**
1413
+ * @public
1287
1414
  * <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
1288
1415
  * of travel and road compatibility. You can choose <code>Car</code>, <code>Truck</code>,
1289
1416
  * <code>Walking</code>, <code>Bicycle</code> or <code>Motorcycle</code> as options for
@@ -1314,6 +1441,7 @@ export interface CalculateRouteRequest {
1314
1441
  */
1315
1442
  TravelMode?: TravelMode | string;
1316
1443
  /**
1444
+ * @public
1317
1445
  * <p>Specifies the desired time of departure. Uses the given time to calculate the route.
1318
1446
  * Otherwise, the best time of day to travel with the best traffic conditions is used to
1319
1447
  * calculate the route.</p>
@@ -1332,6 +1460,7 @@ export interface CalculateRouteRequest {
1332
1460
  */
1333
1461
  DepartureTime?: Date;
1334
1462
  /**
1463
+ * @public
1335
1464
  * <p>Sets the time of departure as the current time. Uses the current time to calculate a
1336
1465
  * route. Otherwise, the best time of day to travel with the best traffic conditions is
1337
1466
  * used to calculate the route.</p>
@@ -1342,12 +1471,14 @@ export interface CalculateRouteRequest {
1342
1471
  */
1343
1472
  DepartNow?: boolean;
1344
1473
  /**
1474
+ * @public
1345
1475
  * <p>Set the unit system to specify the distance.</p>
1346
1476
  * <p>Default Value: <code>Kilometers</code>
1347
1477
  * </p>
1348
1478
  */
1349
1479
  DistanceUnit?: DistanceUnit | string;
1350
1480
  /**
1481
+ * @public
1351
1482
  * <p>Set to include the geometry details in the result for each path between a pair of
1352
1483
  * positions.</p>
1353
1484
  * <p>Default Value: <code>false</code>
@@ -1357,12 +1488,14 @@ export interface CalculateRouteRequest {
1357
1488
  */
1358
1489
  IncludeLegGeometry?: boolean;
1359
1490
  /**
1491
+ * @public
1360
1492
  * <p>Specifies route preferences when traveling by <code>Car</code>, such as avoiding
1361
1493
  * routes that use ferries or tolls.</p>
1362
1494
  * <p>Requirements: <code>TravelMode</code> must be specified as <code>Car</code>.</p>
1363
1495
  */
1364
1496
  CarModeOptions?: CalculateRouteCarModeOptions;
1365
1497
  /**
1498
+ * @public
1366
1499
  * <p>Specifies route preferences when traveling by <code>Truck</code>, such as avoiding
1367
1500
  * routes that use ferries or tolls, and truck specifications to consider when choosing an
1368
1501
  * optimal road.</p>
@@ -1370,6 +1503,7 @@ export interface CalculateRouteRequest {
1370
1503
  */
1371
1504
  TruckModeOptions?: CalculateRouteTruckModeOptions;
1372
1505
  /**
1506
+ * @public
1373
1507
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
1374
1508
  * the request.</p>
1375
1509
  */
@@ -1382,6 +1516,7 @@ export interface CalculateRouteRequest {
1382
1516
  */
1383
1517
  export interface LegGeometry {
1384
1518
  /**
1519
+ * @public
1385
1520
  * <p>An ordered list of positions used to plot a route on a map. </p>
1386
1521
  * <p>The first position is closest to the start position for the leg, and the last position
1387
1522
  * is the closest to the end position for the leg.</p>
@@ -1402,27 +1537,32 @@ export interface LegGeometry {
1402
1537
  */
1403
1538
  export interface Step {
1404
1539
  /**
1540
+ * @public
1405
1541
  * <p>The starting position of a step. If the position is the first step in the leg, this
1406
1542
  * position is the same as the start position of the leg.</p>
1407
1543
  */
1408
1544
  StartPosition: number[] | undefined;
1409
1545
  /**
1546
+ * @public
1410
1547
  * <p>The end position of a step. If the position the last step in the leg, this position is
1411
1548
  * the same as the end position of the leg.</p>
1412
1549
  */
1413
1550
  EndPosition: number[] | undefined;
1414
1551
  /**
1552
+ * @public
1415
1553
  * <p>The travel distance between the step's <code>StartPosition</code> and
1416
1554
  * <code>EndPosition</code>.</p>
1417
1555
  */
1418
1556
  Distance: number | undefined;
1419
1557
  /**
1558
+ * @public
1420
1559
  * <p>The estimated travel time, in seconds, from the step's <code>StartPosition</code> to
1421
1560
  * the <code>EndPosition</code>. . The travel mode and departure time that you specify in
1422
1561
  * the request determines the calculated time.</p>
1423
1562
  */
1424
1563
  DurationSeconds: number | undefined;
1425
1564
  /**
1565
+ * @public
1426
1566
  * <p>Represents the start position, or index, in a sequence of steps within the leg's line
1427
1567
  * string geometry. For example, the index of the first step in a leg geometry is
1428
1568
  * <code>0</code>. </p>
@@ -1462,6 +1602,7 @@ export interface Step {
1462
1602
  */
1463
1603
  export interface Leg {
1464
1604
  /**
1605
+ * @public
1465
1606
  * <p>The starting position of the leg. Follows the format
1466
1607
  * <code>[longitude,latitude]</code>.</p>
1467
1608
  * <note>
@@ -1471,6 +1612,7 @@ export interface Leg {
1471
1612
  */
1472
1613
  StartPosition: number[] | undefined;
1473
1614
  /**
1615
+ * @public
1474
1616
  * <p>The terminating position of the leg. Follows the format
1475
1617
  * <code>[longitude,latitude]</code>.</p>
1476
1618
  * <note>
@@ -1480,6 +1622,7 @@ export interface Leg {
1480
1622
  */
1481
1623
  EndPosition: number[] | undefined;
1482
1624
  /**
1625
+ * @public
1483
1626
  * <p>The distance between the leg's <code>StartPosition</code> and <code>EndPosition</code>
1484
1627
  * along a calculated route. </p>
1485
1628
  * <ul>
@@ -1491,16 +1634,19 @@ export interface Leg {
1491
1634
  */
1492
1635
  Distance: number | undefined;
1493
1636
  /**
1637
+ * @public
1494
1638
  * <p>The estimated travel time between the leg's <code>StartPosition</code> and
1495
1639
  * <code>EndPosition</code>. The travel mode and departure time that you specify in the
1496
1640
  * request determines the calculated time.</p>
1497
1641
  */
1498
1642
  DurationSeconds: number | undefined;
1499
1643
  /**
1644
+ * @public
1500
1645
  * <p>Contains the calculated route's path as a linestring geometry.</p>
1501
1646
  */
1502
1647
  Geometry?: LegGeometry;
1503
1648
  /**
1649
+ * @public
1504
1650
  * <p>Contains a list of steps, which represent subsections of a leg. Each step provides
1505
1651
  * instructions for how to move to the next step in the leg such as the step's start
1506
1652
  * position, end position, travel distance, travel duration, and geometry offset.</p>
@@ -1513,6 +1659,7 @@ export interface Leg {
1513
1659
  */
1514
1660
  export interface CalculateRouteSummary {
1515
1661
  /**
1662
+ * @public
1516
1663
  * <p>Specifies a geographical box surrounding a route. Used to zoom into a route when
1517
1664
  * displaying it in a map. For example, <code>[min x, min y, max x, max y]</code>.</p>
1518
1665
  * <p>The first 2 <code>bbox</code> parameters describe the lower southwest corner: </p>
@@ -1540,6 +1687,7 @@ export interface CalculateRouteSummary {
1540
1687
  */
1541
1688
  RouteBBox: number[] | undefined;
1542
1689
  /**
1690
+ * @public
1543
1691
  * <p>The data provider of traffic and road network data used to calculate the route.
1544
1692
  * Indicates one of the available providers:</p>
1545
1693
  * <ul>
@@ -1563,6 +1711,7 @@ export interface CalculateRouteSummary {
1563
1711
  */
1564
1712
  DataSource: string | undefined;
1565
1713
  /**
1714
+ * @public
1566
1715
  * <p>The total distance covered by the route. The sum of the distance travelled between
1567
1716
  * every stop on the route.</p>
1568
1717
  * <note>
@@ -1573,12 +1722,14 @@ export interface CalculateRouteSummary {
1573
1722
  */
1574
1723
  Distance: number | undefined;
1575
1724
  /**
1725
+ * @public
1576
1726
  * <p>The total travel time for the route measured in seconds. The sum of the travel time
1577
1727
  * between every stop on the
1578
1728
  * route.</p>
1579
1729
  */
1580
1730
  DurationSeconds: number | undefined;
1581
1731
  /**
1732
+ * @public
1582
1733
  * <p>The unit of measurement for route distances.</p>
1583
1734
  */
1584
1735
  DistanceUnit: DistanceUnit | string | undefined;
@@ -1590,6 +1741,7 @@ export interface CalculateRouteSummary {
1590
1741
  */
1591
1742
  export interface CalculateRouteResponse {
1592
1743
  /**
1744
+ * @public
1593
1745
  * <p>Contains details about each path between a pair of positions included along a route
1594
1746
  * such as: <code>StartPosition</code>, <code>EndPosition</code>, <code>Distance</code>,
1595
1747
  * <code>DurationSeconds</code>, <code>Geometry</code>, and <code>Steps</code>. The
@@ -1621,6 +1773,7 @@ export interface CalculateRouteResponse {
1621
1773
  */
1622
1774
  Legs: Leg[] | undefined;
1623
1775
  /**
1776
+ * @public
1624
1777
  * <p>Contains information about the whole route, such as: <code>RouteBBox</code>,
1625
1778
  * <code>DataSource</code>, <code>Distance</code>, <code>DistanceUnit</code>, and
1626
1779
  * <code>DurationSeconds</code>.</p>
@@ -1632,11 +1785,13 @@ export interface CalculateRouteResponse {
1632
1785
  */
1633
1786
  export interface CalculateRouteMatrixRequest {
1634
1787
  /**
1788
+ * @public
1635
1789
  * <p>The name of the route calculator resource that you want to use to calculate the route
1636
1790
  * matrix. </p>
1637
1791
  */
1638
1792
  CalculatorName: string | undefined;
1639
1793
  /**
1794
+ * @public
1640
1795
  * <p>The list of departure (origin) positions for the route matrix. An array of points,
1641
1796
  * each of which is itself a 2-value array defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
1642
1797
  * <code>[longitude, latitude]</code>. For example, <code>[-123.115,
@@ -1657,6 +1812,7 @@ export interface CalculateRouteMatrixRequest {
1657
1812
  */
1658
1813
  DeparturePositions: number[][] | undefined;
1659
1814
  /**
1815
+ * @public
1660
1816
  * <p>The list of destination positions for the route matrix. An array of points, each of
1661
1817
  * which is itself a 2-value array defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
1662
1818
  * <code>[longitude, latitude]</code>. For example, <code>[-122.339,
@@ -1678,6 +1834,7 @@ export interface CalculateRouteMatrixRequest {
1678
1834
  */
1679
1835
  DestinationPositions: number[][] | undefined;
1680
1836
  /**
1837
+ * @public
1681
1838
  * <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
1682
1839
  * of travel and road compatibility.</p>
1683
1840
  * <p>The <code>TravelMode</code> you specify also determines how you specify route
@@ -1705,6 +1862,7 @@ export interface CalculateRouteMatrixRequest {
1705
1862
  */
1706
1863
  TravelMode?: TravelMode | string;
1707
1864
  /**
1865
+ * @public
1708
1866
  * <p>Specifies the desired time of departure. Uses the given time to calculate the route
1709
1867
  * matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>. If
1710
1868
  * neither is set, the best time of day to travel with the best traffic conditions is used
@@ -1724,6 +1882,7 @@ export interface CalculateRouteMatrixRequest {
1724
1882
  */
1725
1883
  DepartureTime?: Date;
1726
1884
  /**
1885
+ * @public
1727
1886
  * <p>Sets the time of departure as the current time. Uses the current time to calculate the
1728
1887
  * route matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>.
1729
1888
  * If neither is set, the best time of day to travel with the best traffic conditions is
@@ -1735,18 +1894,21 @@ export interface CalculateRouteMatrixRequest {
1735
1894
  */
1736
1895
  DepartNow?: boolean;
1737
1896
  /**
1897
+ * @public
1738
1898
  * <p>Set the unit system to specify the distance.</p>
1739
1899
  * <p>Default Value: <code>Kilometers</code>
1740
1900
  * </p>
1741
1901
  */
1742
1902
  DistanceUnit?: DistanceUnit | string;
1743
1903
  /**
1904
+ * @public
1744
1905
  * <p>Specifies route preferences when traveling by <code>Car</code>, such as avoiding
1745
1906
  * routes that use ferries or tolls.</p>
1746
1907
  * <p>Requirements: <code>TravelMode</code> must be specified as <code>Car</code>.</p>
1747
1908
  */
1748
1909
  CarModeOptions?: CalculateRouteCarModeOptions;
1749
1910
  /**
1911
+ * @public
1750
1912
  * <p>Specifies route preferences when traveling by <code>Truck</code>, such as avoiding
1751
1913
  * routes that use ferries or tolls, and truck specifications to consider when choosing an
1752
1914
  * optimal road.</p>
@@ -1754,6 +1916,7 @@ export interface CalculateRouteMatrixRequest {
1754
1916
  */
1755
1917
  TruckModeOptions?: CalculateRouteTruckModeOptions;
1756
1918
  /**
1919
+ * @public
1757
1920
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
1758
1921
  * the request.</p>
1759
1922
  */
@@ -1815,10 +1978,12 @@ export type RouteMatrixErrorCode = "DeparturePositionNotFound" | "DestinationPos
1815
1978
  */
1816
1979
  export interface RouteMatrixEntryError {
1817
1980
  /**
1981
+ * @public
1818
1982
  * <p>The type of error which occurred for the route calculation.</p>
1819
1983
  */
1820
1984
  Code: RouteMatrixErrorCode | string | undefined;
1821
1985
  /**
1986
+ * @public
1822
1987
  * <p>A message about the error that occurred for the route calculation.</p>
1823
1988
  */
1824
1989
  Message?: string;
@@ -1830,14 +1995,17 @@ export interface RouteMatrixEntryError {
1830
1995
  */
1831
1996
  export interface RouteMatrixEntry {
1832
1997
  /**
1998
+ * @public
1833
1999
  * <p>The total distance of travel for the route.</p>
1834
2000
  */
1835
2001
  Distance?: number;
1836
2002
  /**
2003
+ * @public
1837
2004
  * <p>The expected duration of travel for the route.</p>
1838
2005
  */
1839
2006
  DurationSeconds?: number;
1840
2007
  /**
2008
+ * @public
1841
2009
  * <p>An error corresponding to the calculation of a route between the
1842
2010
  * <code>DeparturePosition</code> and <code>DestinationPosition</code>.</p>
1843
2011
  */
@@ -1849,6 +2017,7 @@ export interface RouteMatrixEntry {
1849
2017
  */
1850
2018
  export interface CalculateRouteMatrixSummary {
1851
2019
  /**
2020
+ * @public
1852
2021
  * <p>The data provider of traffic and road network data used to calculate the routes.
1853
2022
  * Indicates one of the available providers:</p>
1854
2023
  * <ul>
@@ -1873,17 +2042,20 @@ export interface CalculateRouteMatrixSummary {
1873
2042
  */
1874
2043
  DataSource: string | undefined;
1875
2044
  /**
2045
+ * @public
1876
2046
  * <p>The count of cells in the route matrix. Equal to the number of
1877
2047
  * <code>DeparturePositions</code> multiplied by the number of
1878
2048
  * <code>DestinationPositions</code>.</p>
1879
2049
  */
1880
2050
  RouteCount: number | undefined;
1881
2051
  /**
2052
+ * @public
1882
2053
  * <p>The count of error results in the route matrix. If this number is 0, all routes were
1883
2054
  * calculated successfully.</p>
1884
2055
  */
1885
2056
  ErrorCount: number | undefined;
1886
2057
  /**
2058
+ * @public
1887
2059
  * <p>The unit of measurement for route distances.</p>
1888
2060
  */
1889
2061
  DistanceUnit: DistanceUnit | string | undefined;
@@ -1894,6 +2066,7 @@ export interface CalculateRouteMatrixSummary {
1894
2066
  */
1895
2067
  export interface CalculateRouteMatrixResponse {
1896
2068
  /**
2069
+ * @public
1897
2070
  * <p>The calculated route matrix containing the results for all pairs of
1898
2071
  * <code>DeparturePositions</code> to <code>DestinationPositions</code>. Each row
1899
2072
  * corresponds to one entry in <code>DeparturePositions</code>. Each entry in the row
@@ -1902,6 +2075,7 @@ export interface CalculateRouteMatrixResponse {
1902
2075
  */
1903
2076
  RouteMatrix: RouteMatrixEntry[][] | undefined;
1904
2077
  /**
2078
+ * @public
1905
2079
  * <p>For routes calculated using an Esri route calculator resource, departure positions are
1906
2080
  * snapped to the closest road. For Esri route calculator resources, this returns the list
1907
2081
  * of departure/origin positions used for calculation of the
@@ -1909,11 +2083,13 @@ export interface CalculateRouteMatrixResponse {
1909
2083
  */
1910
2084
  SnappedDeparturePositions?: number[][];
1911
2085
  /**
2086
+ * @public
1912
2087
  * <p>The list of destination positions for the route matrix used for calculation of the
1913
2088
  * <code>RouteMatrix</code>.</p>
1914
2089
  */
1915
2090
  SnappedDestinationPositions?: number[][];
1916
2091
  /**
2092
+ * @public
1917
2093
  * <p>Contains information about the route matrix, <code>DataSource</code>,
1918
2094
  * <code>DistanceUnit</code>, <code>RouteCount</code> and
1919
2095
  * <code>ErrorCount</code>.</p>
@@ -1929,6 +2105,7 @@ export type PricingPlan = "MobileAssetManagement" | "MobileAssetTracking" | "Req
1929
2105
  */
1930
2106
  export interface CreateGeofenceCollectionRequest {
1931
2107
  /**
2108
+ * @public
1932
2109
  * <p>A custom name for the geofence collection.</p>
1933
2110
  * <p>Requirements:</p>
1934
2111
  * <ul>
@@ -1946,6 +2123,7 @@ export interface CreateGeofenceCollectionRequest {
1946
2123
  */
1947
2124
  CollectionName: string | undefined;
1948
2125
  /**
2126
+ * @public
1949
2127
  * @deprecated
1950
2128
  *
1951
2129
  * <p>No longer used. If included, the only allowed value is
@@ -1953,16 +2131,19 @@ export interface CreateGeofenceCollectionRequest {
1953
2131
  */
1954
2132
  PricingPlan?: PricingPlan | string;
1955
2133
  /**
2134
+ * @public
1956
2135
  * @deprecated
1957
2136
  *
1958
2137
  * <p>This parameter is no longer used.</p>
1959
2138
  */
1960
2139
  PricingPlanDataSource?: string;
1961
2140
  /**
2141
+ * @public
1962
2142
  * <p>An optional description for the geofence collection.</p>
1963
2143
  */
1964
2144
  Description?: string;
1965
2145
  /**
2146
+ * @public
1966
2147
  * <p>Applies one or more tags to the geofence collection. A tag is a key-value pair helps
1967
2148
  * manage, identify, search, and filter your resources by labelling them.</p>
1968
2149
  * <p>Format: <code>"key" : "value"</code>
@@ -1992,6 +2173,7 @@ export interface CreateGeofenceCollectionRequest {
1992
2173
  */
1993
2174
  Tags?: Record<string, string>;
1994
2175
  /**
2176
+ * @public
1995
2177
  * <p>A key identifier for an
1996
2178
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services
1997
2179
  * KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.
@@ -2004,10 +2186,12 @@ export interface CreateGeofenceCollectionRequest {
2004
2186
  */
2005
2187
  export interface CreateGeofenceCollectionResponse {
2006
2188
  /**
2189
+ * @public
2007
2190
  * <p>The name for the geofence collection.</p>
2008
2191
  */
2009
2192
  CollectionName: string | undefined;
2010
2193
  /**
2194
+ * @public
2011
2195
  * <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you
2012
2196
  * need to specify a resource across all Amazon Web Services. </p>
2013
2197
  * <ul>
@@ -2020,6 +2204,7 @@ export interface CreateGeofenceCollectionResponse {
2020
2204
  */
2021
2205
  CollectionArn: string | undefined;
2022
2206
  /**
2207
+ * @public
2023
2208
  * <p>The timestamp for when the geofence collection was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2024
2209
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2025
2210
  * </p>
@@ -2032,6 +2217,7 @@ export interface CreateGeofenceCollectionResponse {
2032
2217
  */
2033
2218
  export interface MapConfiguration {
2034
2219
  /**
2220
+ * @public
2035
2221
  * <p>Specifies the map style selected from an available data provider.</p>
2036
2222
  * <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri map styles</a>:</p>
2037
2223
  * <ul>
@@ -2175,6 +2361,7 @@ export interface MapConfiguration {
2175
2361
  */
2176
2362
  Style: string | undefined;
2177
2363
  /**
2364
+ * @public
2178
2365
  * <p>Specifies the political view for the style. Leave unset to not use a political
2179
2366
  * view, or, for styles that support specific political views, you can choose a view,
2180
2367
  * such as <code>IND</code> for the Indian view.</p>
@@ -2193,6 +2380,7 @@ export interface MapConfiguration {
2193
2380
  */
2194
2381
  export interface CreateMapRequest {
2195
2382
  /**
2383
+ * @public
2196
2384
  * <p>The name for the map resource.</p>
2197
2385
  * <p>Requirements:</p>
2198
2386
  * <ul>
@@ -2209,12 +2397,14 @@ export interface CreateMapRequest {
2209
2397
  */
2210
2398
  MapName: string | undefined;
2211
2399
  /**
2400
+ * @public
2212
2401
  * <p>Specifies the <code>MapConfiguration</code>, including the map style, for the
2213
2402
  * map resource that you create. The map style defines the look of maps and the data
2214
2403
  * provider for your map resource.</p>
2215
2404
  */
2216
2405
  Configuration: MapConfiguration | undefined;
2217
2406
  /**
2407
+ * @public
2218
2408
  * @deprecated
2219
2409
  *
2220
2410
  * <p>No longer used. If included, the only allowed value is
@@ -2222,10 +2412,12 @@ export interface CreateMapRequest {
2222
2412
  */
2223
2413
  PricingPlan?: PricingPlan | string;
2224
2414
  /**
2415
+ * @public
2225
2416
  * <p>An optional description for the map resource.</p>
2226
2417
  */
2227
2418
  Description?: string;
2228
2419
  /**
2420
+ * @public
2229
2421
  * <p>Applies one or more tags to the map resource. A tag is a key-value pair helps manage,
2230
2422
  * identify, search, and filter your resources by labelling them.</p>
2231
2423
  * <p>Format: <code>"key" : "value"</code>
@@ -2260,10 +2452,12 @@ export interface CreateMapRequest {
2260
2452
  */
2261
2453
  export interface CreateMapResponse {
2262
2454
  /**
2455
+ * @public
2263
2456
  * <p>The name of the map resource.</p>
2264
2457
  */
2265
2458
  MapName: string | undefined;
2266
2459
  /**
2460
+ * @public
2267
2461
  * <p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across
2268
2462
  * all Amazon Web Services.</p>
2269
2463
  * <ul>
@@ -2276,6 +2470,7 @@ export interface CreateMapResponse {
2276
2470
  */
2277
2471
  MapArn: string | undefined;
2278
2472
  /**
2473
+ * @public
2279
2474
  * <p>The timestamp for when the map resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2280
2475
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
2281
2476
  */
@@ -2308,6 +2503,7 @@ export type IntendedUse = "SingleUse" | "Storage";
2308
2503
  */
2309
2504
  export interface DataSourceConfiguration {
2310
2505
  /**
2506
+ * @public
2311
2507
  * <p>Specifies how the results of an operation will be stored by the caller. </p>
2312
2508
  * <p>Valid values include:</p>
2313
2509
  * <ul>
@@ -2331,6 +2527,7 @@ export interface DataSourceConfiguration {
2331
2527
  */
2332
2528
  export interface CreatePlaceIndexRequest {
2333
2529
  /**
2530
+ * @public
2334
2531
  * <p>The name of the place index resource. </p>
2335
2532
  * <p>Requirements:</p>
2336
2533
  * <ul>
@@ -2348,6 +2545,7 @@ export interface CreatePlaceIndexRequest {
2348
2545
  */
2349
2546
  IndexName: string | undefined;
2350
2547
  /**
2548
+ * @public
2351
2549
  * <p>Specifies the geospatial data provider for the new place index.</p>
2352
2550
  * <note>
2353
2551
  * <p>This field is case-sensitive. Enter the valid values as shown. For example,
@@ -2381,6 +2579,7 @@ export interface CreatePlaceIndexRequest {
2381
2579
  */
2382
2580
  DataSource: string | undefined;
2383
2581
  /**
2582
+ * @public
2384
2583
  * @deprecated
2385
2584
  *
2386
2585
  * <p>No longer used. If included, the only allowed value is
@@ -2388,14 +2587,17 @@ export interface CreatePlaceIndexRequest {
2388
2587
  */
2389
2588
  PricingPlan?: PricingPlan | string;
2390
2589
  /**
2590
+ * @public
2391
2591
  * <p>The optional description for the place index resource.</p>
2392
2592
  */
2393
2593
  Description?: string;
2394
2594
  /**
2595
+ * @public
2395
2596
  * <p>Specifies the data storage option requesting Places.</p>
2396
2597
  */
2397
2598
  DataSourceConfiguration?: DataSourceConfiguration;
2398
2599
  /**
2600
+ * @public
2399
2601
  * <p>Applies one or more tags to the place index resource. A tag is a key-value pair that
2400
2602
  * helps you manage, identify, search, and filter your resources.</p>
2401
2603
  * <p>Format: <code>"key" : "value"</code>
@@ -2430,10 +2632,12 @@ export interface CreatePlaceIndexRequest {
2430
2632
  */
2431
2633
  export interface CreatePlaceIndexResponse {
2432
2634
  /**
2635
+ * @public
2433
2636
  * <p>The name for the place index resource.</p>
2434
2637
  */
2435
2638
  IndexName: string | undefined;
2436
2639
  /**
2640
+ * @public
2437
2641
  * <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
2438
2642
  * resource across Amazon Web Services. </p>
2439
2643
  * <ul>
@@ -2446,6 +2650,7 @@ export interface CreatePlaceIndexResponse {
2446
2650
  */
2447
2651
  IndexArn: string | undefined;
2448
2652
  /**
2653
+ * @public
2449
2654
  * <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2450
2655
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2451
2656
  */
@@ -2456,6 +2661,7 @@ export interface CreatePlaceIndexResponse {
2456
2661
  */
2457
2662
  export interface CreateRouteCalculatorRequest {
2458
2663
  /**
2664
+ * @public
2459
2665
  * <p>The name of the route calculator resource. </p>
2460
2666
  * <p>Requirements:</p>
2461
2667
  * <ul>
@@ -2473,6 +2679,7 @@ export interface CreateRouteCalculatorRequest {
2473
2679
  */
2474
2680
  CalculatorName: string | undefined;
2475
2681
  /**
2682
+ * @public
2476
2683
  * <p>Specifies the data provider of traffic and road network data.</p>
2477
2684
  * <note>
2478
2685
  * <p>This field is case-sensitive. Enter the valid values as shown. For example,
@@ -2504,6 +2711,7 @@ export interface CreateRouteCalculatorRequest {
2504
2711
  */
2505
2712
  DataSource: string | undefined;
2506
2713
  /**
2714
+ * @public
2507
2715
  * @deprecated
2508
2716
  *
2509
2717
  * <p>No longer used. If included, the only allowed value is
@@ -2511,10 +2719,12 @@ export interface CreateRouteCalculatorRequest {
2511
2719
  */
2512
2720
  PricingPlan?: PricingPlan | string;
2513
2721
  /**
2722
+ * @public
2514
2723
  * <p>The optional description for the route calculator resource.</p>
2515
2724
  */
2516
2725
  Description?: string;
2517
2726
  /**
2727
+ * @public
2518
2728
  * <p>Applies one or more tags to the route calculator resource. A tag is a key-value pair
2519
2729
  * helps manage, identify, search, and filter your resources by labelling them.</p>
2520
2730
  * <ul>
@@ -2555,6 +2765,7 @@ export interface CreateRouteCalculatorRequest {
2555
2765
  */
2556
2766
  export interface CreateRouteCalculatorResponse {
2557
2767
  /**
2768
+ * @public
2558
2769
  * <p>The name of the route calculator resource. </p>
2559
2770
  * <ul>
2560
2771
  * <li>
@@ -2564,6 +2775,7 @@ export interface CreateRouteCalculatorResponse {
2564
2775
  */
2565
2776
  CalculatorName: string | undefined;
2566
2777
  /**
2778
+ * @public
2567
2779
  * <p>The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you
2568
2780
  * specify a resource across all Amazon Web Services.</p>
2569
2781
  * <ul>
@@ -2576,6 +2788,7 @@ export interface CreateRouteCalculatorResponse {
2576
2788
  */
2577
2789
  CalculatorArn: string | undefined;
2578
2790
  /**
2791
+ * @public
2579
2792
  * <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2580
2793
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2581
2794
  * <ul>
@@ -2596,6 +2809,7 @@ export type PositionFiltering = "AccuracyBased" | "DistanceBased" | "TimeBased";
2596
2809
  */
2597
2810
  export interface CreateTrackerRequest {
2598
2811
  /**
2812
+ * @public
2599
2813
  * <p>The name for the tracker resource.</p>
2600
2814
  * <p>Requirements:</p>
2601
2815
  * <ul>
@@ -2612,6 +2826,7 @@ export interface CreateTrackerRequest {
2612
2826
  */
2613
2827
  TrackerName: string | undefined;
2614
2828
  /**
2829
+ * @public
2615
2830
  * @deprecated
2616
2831
  *
2617
2832
  * <p>No longer used. If included, the only allowed value is
@@ -2619,22 +2834,26 @@ export interface CreateTrackerRequest {
2619
2834
  */
2620
2835
  PricingPlan?: PricingPlan | string;
2621
2836
  /**
2837
+ * @public
2622
2838
  * <p>A key identifier for an
2623
2839
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services
2624
2840
  * KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
2625
2841
  */
2626
2842
  KmsKeyId?: string;
2627
2843
  /**
2844
+ * @public
2628
2845
  * @deprecated
2629
2846
  *
2630
2847
  * <p>This parameter is no longer used.</p>
2631
2848
  */
2632
2849
  PricingPlanDataSource?: string;
2633
2850
  /**
2851
+ * @public
2634
2852
  * <p>An optional description for the tracker resource.</p>
2635
2853
  */
2636
2854
  Description?: string;
2637
2855
  /**
2856
+ * @public
2638
2857
  * <p>Applies one or more tags to the tracker resource. A tag is a key-value pair helps
2639
2858
  * manage, identify, search, and filter your resources by labelling them.</p>
2640
2859
  * <p>Format: <code>"key" : "value"</code>
@@ -2664,6 +2883,7 @@ export interface CreateTrackerRequest {
2664
2883
  */
2665
2884
  Tags?: Record<string, string>;
2666
2885
  /**
2886
+ * @public
2667
2887
  * <p>Specifies the position filtering for the tracker resource.</p>
2668
2888
  * <p>Valid values:</p>
2669
2889
  * <ul>
@@ -2698,6 +2918,7 @@ export interface CreateTrackerRequest {
2698
2918
  */
2699
2919
  PositionFiltering?: PositionFiltering | string;
2700
2920
  /**
2921
+ * @public
2701
2922
  * <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to
2702
2923
  * EventBridge.</p>
2703
2924
  * <note>
@@ -2713,10 +2934,12 @@ export interface CreateTrackerRequest {
2713
2934
  */
2714
2935
  export interface CreateTrackerResponse {
2715
2936
  /**
2937
+ * @public
2716
2938
  * <p>The name of the tracker resource.</p>
2717
2939
  */
2718
2940
  TrackerName: string | undefined;
2719
2941
  /**
2942
+ * @public
2720
2943
  * <p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify
2721
2944
  * a resource across all Amazon Web Services.</p>
2722
2945
  * <ul>
@@ -2729,6 +2952,7 @@ export interface CreateTrackerResponse {
2729
2952
  */
2730
2953
  TrackerArn: string | undefined;
2731
2954
  /**
2955
+ * @public
2732
2956
  * <p>The timestamp for when the tracker resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
2733
2957
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2734
2958
  */
@@ -2739,6 +2963,7 @@ export interface CreateTrackerResponse {
2739
2963
  */
2740
2964
  export interface DeleteGeofenceCollectionRequest {
2741
2965
  /**
2966
+ * @public
2742
2967
  * <p>The name of the geofence collection to be deleted.</p>
2743
2968
  */
2744
2969
  CollectionName: string | undefined;
@@ -2753,6 +2978,7 @@ export interface DeleteGeofenceCollectionResponse {
2753
2978
  */
2754
2979
  export interface DeleteMapRequest {
2755
2980
  /**
2981
+ * @public
2756
2982
  * <p>The name of the map resource to be deleted.</p>
2757
2983
  */
2758
2984
  MapName: string | undefined;
@@ -2767,6 +2993,7 @@ export interface DeleteMapResponse {
2767
2993
  */
2768
2994
  export interface DeletePlaceIndexRequest {
2769
2995
  /**
2996
+ * @public
2770
2997
  * <p>The name of the place index resource to be deleted.</p>
2771
2998
  */
2772
2999
  IndexName: string | undefined;
@@ -2781,6 +3008,7 @@ export interface DeletePlaceIndexResponse {
2781
3008
  */
2782
3009
  export interface DeleteRouteCalculatorRequest {
2783
3010
  /**
3011
+ * @public
2784
3012
  * <p>The name of the route calculator resource to be deleted.</p>
2785
3013
  */
2786
3014
  CalculatorName: string | undefined;
@@ -2795,6 +3023,7 @@ export interface DeleteRouteCalculatorResponse {
2795
3023
  */
2796
3024
  export interface DeleteTrackerRequest {
2797
3025
  /**
3026
+ * @public
2798
3027
  * <p>The name of the tracker resource to be deleted.</p>
2799
3028
  */
2800
3029
  TrackerName: string | undefined;
@@ -2809,6 +3038,7 @@ export interface DeleteTrackerResponse {
2809
3038
  */
2810
3039
  export interface DescribeGeofenceCollectionRequest {
2811
3040
  /**
3041
+ * @public
2812
3042
  * <p>The name of the geofence collection.</p>
2813
3043
  */
2814
3044
  CollectionName: string | undefined;
@@ -2818,10 +3048,12 @@ export interface DescribeGeofenceCollectionRequest {
2818
3048
  */
2819
3049
  export interface DescribeGeofenceCollectionResponse {
2820
3050
  /**
3051
+ * @public
2821
3052
  * <p>The name of the geofence collection.</p>
2822
3053
  */
2823
3054
  CollectionName: string | undefined;
2824
3055
  /**
3056
+ * @public
2825
3057
  * <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you
2826
3058
  * need to specify a resource across all Amazon Web Services. </p>
2827
3059
  * <ul>
@@ -2834,38 +3066,45 @@ export interface DescribeGeofenceCollectionResponse {
2834
3066
  */
2835
3067
  CollectionArn: string | undefined;
2836
3068
  /**
3069
+ * @public
2837
3070
  * <p>The optional description for the geofence collection.</p>
2838
3071
  */
2839
3072
  Description: string | undefined;
2840
3073
  /**
3074
+ * @public
2841
3075
  * @deprecated
2842
3076
  *
2843
3077
  * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2844
3078
  */
2845
3079
  PricingPlan?: PricingPlan | string;
2846
3080
  /**
3081
+ * @public
2847
3082
  * @deprecated
2848
3083
  *
2849
3084
  * <p>No longer used. Always returns an empty string.</p>
2850
3085
  */
2851
3086
  PricingPlanDataSource?: string;
2852
3087
  /**
3088
+ * @public
2853
3089
  * <p>A key identifier for an
2854
3090
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services
2855
3091
  * KMS customer managed key</a> assigned to the Amazon Location resource</p>
2856
3092
  */
2857
3093
  KmsKeyId?: string;
2858
3094
  /**
3095
+ * @public
2859
3096
  * <p>Displays the key, value pairs of tags associated with this resource.</p>
2860
3097
  */
2861
3098
  Tags?: Record<string, string>;
2862
3099
  /**
3100
+ * @public
2863
3101
  * <p>The timestamp for when the geofence resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2864
3102
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2865
3103
  * </p>
2866
3104
  */
2867
3105
  CreateTime: Date | undefined;
2868
3106
  /**
3107
+ * @public
2869
3108
  * <p>The timestamp for when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2870
3109
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2871
3110
  * </p>
@@ -2877,6 +3116,7 @@ export interface DescribeGeofenceCollectionResponse {
2877
3116
  */
2878
3117
  export interface DescribeMapRequest {
2879
3118
  /**
3119
+ * @public
2880
3120
  * <p>The name of the map resource.</p>
2881
3121
  */
2882
3122
  MapName: string | undefined;
@@ -2886,10 +3126,12 @@ export interface DescribeMapRequest {
2886
3126
  */
2887
3127
  export interface DescribeMapResponse {
2888
3128
  /**
3129
+ * @public
2889
3130
  * <p>The map style selected from an available provider.</p>
2890
3131
  */
2891
3132
  MapName: string | undefined;
2892
3133
  /**
3134
+ * @public
2893
3135
  * <p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across
2894
3136
  * all Amazon Web Services.</p>
2895
3137
  * <ul>
@@ -2902,33 +3144,40 @@ export interface DescribeMapResponse {
2902
3144
  */
2903
3145
  MapArn: string | undefined;
2904
3146
  /**
3147
+ * @public
2905
3148
  * @deprecated
2906
3149
  *
2907
3150
  * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2908
3151
  */
2909
3152
  PricingPlan?: PricingPlan | string;
2910
3153
  /**
3154
+ * @public
2911
3155
  * <p>Specifies the data provider for the associated map tiles.</p>
2912
3156
  */
2913
3157
  DataSource: string | undefined;
2914
3158
  /**
3159
+ * @public
2915
3160
  * <p>Specifies the map tile style selected from a partner data provider.</p>
2916
3161
  */
2917
3162
  Configuration: MapConfiguration | undefined;
2918
3163
  /**
3164
+ * @public
2919
3165
  * <p>The optional description for the map resource.</p>
2920
3166
  */
2921
3167
  Description: string | undefined;
2922
3168
  /**
3169
+ * @public
2923
3170
  * <p>Tags associated with the map resource.</p>
2924
3171
  */
2925
3172
  Tags?: Record<string, string>;
2926
3173
  /**
3174
+ * @public
2927
3175
  * <p>The timestamp for when the map resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2928
3176
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
2929
3177
  */
2930
3178
  CreateTime: Date | undefined;
2931
3179
  /**
3180
+ * @public
2932
3181
  * <p>The timestamp for when the map resource was last update in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2933
3182
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
2934
3183
  */
@@ -2939,6 +3188,7 @@ export interface DescribeMapResponse {
2939
3188
  */
2940
3189
  export interface DescribePlaceIndexRequest {
2941
3190
  /**
3191
+ * @public
2942
3192
  * <p>The name of the place index resource.</p>
2943
3193
  */
2944
3194
  IndexName: string | undefined;
@@ -2948,10 +3198,12 @@ export interface DescribePlaceIndexRequest {
2948
3198
  */
2949
3199
  export interface DescribePlaceIndexResponse {
2950
3200
  /**
3201
+ * @public
2951
3202
  * <p>The name of the place index resource being described.</p>
2952
3203
  */
2953
3204
  IndexName: string | undefined;
2954
3205
  /**
3206
+ * @public
2955
3207
  * <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
2956
3208
  * resource across Amazon Web Services. </p>
2957
3209
  * <ul>
@@ -2964,26 +3216,31 @@ export interface DescribePlaceIndexResponse {
2964
3216
  */
2965
3217
  IndexArn: string | undefined;
2966
3218
  /**
3219
+ * @public
2967
3220
  * @deprecated
2968
3221
  *
2969
3222
  * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2970
3223
  */
2971
3224
  PricingPlan?: PricingPlan | string;
2972
3225
  /**
3226
+ * @public
2973
3227
  * <p>The optional description for the place index resource.</p>
2974
3228
  */
2975
3229
  Description: string | undefined;
2976
3230
  /**
3231
+ * @public
2977
3232
  * <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2978
3233
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2979
3234
  */
2980
3235
  CreateTime: Date | undefined;
2981
3236
  /**
3237
+ * @public
2982
3238
  * <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2983
3239
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2984
3240
  */
2985
3241
  UpdateTime: Date | undefined;
2986
3242
  /**
3243
+ * @public
2987
3244
  * <p>The data provider of geospatial data. Values can be one of the following:</p>
2988
3245
  * <ul>
2989
3246
  * <li>
@@ -3006,10 +3263,12 @@ export interface DescribePlaceIndexResponse {
3006
3263
  */
3007
3264
  DataSource: string | undefined;
3008
3265
  /**
3266
+ * @public
3009
3267
  * <p>The specified data storage option for requesting Places.</p>
3010
3268
  */
3011
3269
  DataSourceConfiguration: DataSourceConfiguration | undefined;
3012
3270
  /**
3271
+ * @public
3013
3272
  * <p>Tags associated with place index resource.</p>
3014
3273
  */
3015
3274
  Tags?: Record<string, string>;
@@ -3019,6 +3278,7 @@ export interface DescribePlaceIndexResponse {
3019
3278
  */
3020
3279
  export interface DescribeRouteCalculatorRequest {
3021
3280
  /**
3281
+ * @public
3022
3282
  * <p>The name of the route calculator resource.</p>
3023
3283
  */
3024
3284
  CalculatorName: string | undefined;
@@ -3028,10 +3288,12 @@ export interface DescribeRouteCalculatorRequest {
3028
3288
  */
3029
3289
  export interface DescribeRouteCalculatorResponse {
3030
3290
  /**
3291
+ * @public
3031
3292
  * <p>The name of the route calculator resource being described.</p>
3032
3293
  */
3033
3294
  CalculatorName: string | undefined;
3034
3295
  /**
3296
+ * @public
3035
3297
  * <p>The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you
3036
3298
  * specify a resource across Amazon Web Services.</p>
3037
3299
  * <ul>
@@ -3044,16 +3306,19 @@ export interface DescribeRouteCalculatorResponse {
3044
3306
  */
3045
3307
  CalculatorArn: string | undefined;
3046
3308
  /**
3309
+ * @public
3047
3310
  * @deprecated
3048
3311
  *
3049
3312
  * <p>Always returns <code>RequestBasedUsage</code>.</p>
3050
3313
  */
3051
3314
  PricingPlan?: PricingPlan | string;
3052
3315
  /**
3316
+ * @public
3053
3317
  * <p>The optional description of the route calculator resource.</p>
3054
3318
  */
3055
3319
  Description: string | undefined;
3056
3320
  /**
3321
+ * @public
3057
3322
  * <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3058
3323
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3059
3324
  * <ul>
@@ -3065,6 +3330,7 @@ export interface DescribeRouteCalculatorResponse {
3065
3330
  */
3066
3331
  CreateTime: Date | undefined;
3067
3332
  /**
3333
+ * @public
3068
3334
  * <p>The timestamp when the route calculator resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3069
3335
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3070
3336
  * <ul>
@@ -3076,6 +3342,7 @@ export interface DescribeRouteCalculatorResponse {
3076
3342
  */
3077
3343
  UpdateTime: Date | undefined;
3078
3344
  /**
3345
+ * @public
3079
3346
  * <p>The data provider of traffic and road network data. Indicates one of the available
3080
3347
  * providers:</p>
3081
3348
  * <ul>
@@ -3099,6 +3366,7 @@ export interface DescribeRouteCalculatorResponse {
3099
3366
  */
3100
3367
  DataSource: string | undefined;
3101
3368
  /**
3369
+ * @public
3102
3370
  * <p>Tags associated with route calculator resource.</p>
3103
3371
  */
3104
3372
  Tags?: Record<string, string>;
@@ -3108,6 +3376,7 @@ export interface DescribeRouteCalculatorResponse {
3108
3376
  */
3109
3377
  export interface DescribeTrackerRequest {
3110
3378
  /**
3379
+ * @public
3111
3380
  * <p>The name of the tracker resource.</p>
3112
3381
  */
3113
3382
  TrackerName: string | undefined;
@@ -3117,10 +3386,12 @@ export interface DescribeTrackerRequest {
3117
3386
  */
3118
3387
  export interface DescribeTrackerResponse {
3119
3388
  /**
3389
+ * @public
3120
3390
  * <p>The name of the tracker resource.</p>
3121
3391
  */
3122
3392
  TrackerName: string | undefined;
3123
3393
  /**
3394
+ * @public
3124
3395
  * <p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify
3125
3396
  * a resource across all Amazon Web Services.</p>
3126
3397
  * <ul>
@@ -3133,45 +3404,54 @@ export interface DescribeTrackerResponse {
3133
3404
  */
3134
3405
  TrackerArn: string | undefined;
3135
3406
  /**
3407
+ * @public
3136
3408
  * <p>The optional description for the tracker resource.</p>
3137
3409
  */
3138
3410
  Description: string | undefined;
3139
3411
  /**
3412
+ * @public
3140
3413
  * @deprecated
3141
3414
  *
3142
3415
  * <p>Always returns <code>RequestBasedUsage</code>.</p>
3143
3416
  */
3144
3417
  PricingPlan?: PricingPlan | string;
3145
3418
  /**
3419
+ * @public
3146
3420
  * @deprecated
3147
3421
  *
3148
3422
  * <p>No longer used. Always returns an empty string.</p>
3149
3423
  */
3150
3424
  PricingPlanDataSource?: string;
3151
3425
  /**
3426
+ * @public
3152
3427
  * <p>The tags associated with the tracker resource.</p>
3153
3428
  */
3154
3429
  Tags?: Record<string, string>;
3155
3430
  /**
3431
+ * @public
3156
3432
  * <p>The timestamp for when the tracker resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
3157
3433
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3158
3434
  */
3159
3435
  CreateTime: Date | undefined;
3160
3436
  /**
3437
+ * @public
3161
3438
  * <p>The timestamp for when the tracker resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
3162
3439
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3163
3440
  */
3164
3441
  UpdateTime: Date | undefined;
3165
3442
  /**
3443
+ * @public
3166
3444
  * <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services
3167
3445
  * KMS customer managed key</a> assigned to the Amazon Location resource.</p>
3168
3446
  */
3169
3447
  KmsKeyId?: string;
3170
3448
  /**
3449
+ * @public
3171
3450
  * <p>The position filtering method of the tracker resource.</p>
3172
3451
  */
3173
3452
  PositionFiltering?: PositionFiltering | string;
3174
3453
  /**
3454
+ * @public
3175
3455
  * <p>Whether <code>UPDATE</code> events from this tracker in EventBridge are
3176
3456
  * enabled. If set to <code>true</code> these events will be sent to EventBridge.</p>
3177
3457
  */
@@ -3182,10 +3462,12 @@ export interface DescribeTrackerResponse {
3182
3462
  */
3183
3463
  export interface DisassociateTrackerConsumerRequest {
3184
3464
  /**
3465
+ * @public
3185
3466
  * <p>The name of the tracker resource to be dissociated from the consumer.</p>
3186
3467
  */
3187
3468
  TrackerName: string | undefined;
3188
3469
  /**
3470
+ * @public
3189
3471
  * <p>The Amazon Resource Name (ARN) for the geofence collection to be disassociated from
3190
3472
  * the tracker resource. Used when you need to specify a resource across all Amazon Web Services. </p>
3191
3473
  * <ul>
@@ -3208,6 +3490,7 @@ export interface DisassociateTrackerConsumerResponse {
3208
3490
  */
3209
3491
  export interface ListTagsForResourceRequest {
3210
3492
  /**
3493
+ * @public
3211
3494
  * <p>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</p>
3212
3495
  * <ul>
3213
3496
  * <li>
@@ -3224,6 +3507,7 @@ export interface ListTagsForResourceRequest {
3224
3507
  */
3225
3508
  export interface ListTagsForResourceResponse {
3226
3509
  /**
3510
+ * @public
3227
3511
  * <p>Tags that have been applied to the specified resource. Tags are mapped from the tag
3228
3512
  * key to the tag value: <code>"TagKey" : "TagValue"</code>.</p>
3229
3513
  * <ul>
@@ -3240,6 +3524,7 @@ export interface ListTagsForResourceResponse {
3240
3524
  */
3241
3525
  export interface TagResourceRequest {
3242
3526
  /**
3527
+ * @public
3243
3528
  * <p>The Amazon Resource Name (ARN) of the resource whose tags you want to update.</p>
3244
3529
  * <ul>
3245
3530
  * <li>
@@ -3251,6 +3536,7 @@ export interface TagResourceRequest {
3251
3536
  */
3252
3537
  ResourceArn: string | undefined;
3253
3538
  /**
3539
+ * @public
3254
3540
  * <p>Applies one or more tags to specific resource. A tag is a key-value pair that helps
3255
3541
  * you manage, identify, search, and filter your resources.</p>
3256
3542
  * <p>Format: <code>"key" : "value"</code>
@@ -3290,6 +3576,7 @@ export interface TagResourceResponse {
3290
3576
  */
3291
3577
  export interface UntagResourceRequest {
3292
3578
  /**
3579
+ * @public
3293
3580
  * <p>The Amazon Resource Name (ARN) of the resource from which you want to remove
3294
3581
  * tags.</p>
3295
3582
  * <ul>
@@ -3302,6 +3589,7 @@ export interface UntagResourceRequest {
3302
3589
  */
3303
3590
  ResourceArn: string | undefined;
3304
3591
  /**
3592
+ * @public
3305
3593
  * <p>The list of tag keys to remove from the specified resource.</p>
3306
3594
  */
3307
3595
  TagKeys: string[] | undefined;
@@ -3316,10 +3604,12 @@ export interface UntagResourceResponse {
3316
3604
  */
3317
3605
  export interface GetGeofenceRequest {
3318
3606
  /**
3607
+ * @public
3319
3608
  * <p>The geofence collection storing the target geofence.</p>
3320
3609
  */
3321
3610
  CollectionName: string | undefined;
3322
3611
  /**
3612
+ * @public
3323
3613
  * <p>The geofence you're retrieving details for.</p>
3324
3614
  */
3325
3615
  GeofenceId: string | undefined;
@@ -3329,14 +3619,17 @@ export interface GetGeofenceRequest {
3329
3619
  */
3330
3620
  export interface GetGeofenceResponse {
3331
3621
  /**
3622
+ * @public
3332
3623
  * <p>The geofence identifier.</p>
3333
3624
  */
3334
3625
  GeofenceId: string | undefined;
3335
3626
  /**
3627
+ * @public
3336
3628
  * <p>Contains the geofence geometry details describing a polygon or a circle.</p>
3337
3629
  */
3338
3630
  Geometry: GeofenceGeometry | undefined;
3339
3631
  /**
3632
+ * @public
3340
3633
  * <p>Identifies the state of the geofence. A geofence will hold one of the following
3341
3634
  * states:</p>
3342
3635
  * <ul>
@@ -3366,18 +3659,21 @@ export interface GetGeofenceResponse {
3366
3659
  */
3367
3660
  Status: string | undefined;
3368
3661
  /**
3662
+ * @public
3369
3663
  * <p>The timestamp for when the geofence collection was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3370
3664
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3371
3665
  * </p>
3372
3666
  */
3373
3667
  CreateTime: Date | undefined;
3374
3668
  /**
3669
+ * @public
3375
3670
  * <p>The timestamp for when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3376
3671
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3377
3672
  * </p>
3378
3673
  */
3379
3674
  UpdateTime: Date | undefined;
3380
3675
  /**
3676
+ * @public
3381
3677
  * <p>User defined properties of the geofence. A property is a key-value
3382
3678
  * pair stored with the geofence and added to any geofence event triggered with that
3383
3679
  * geofence.</p>
@@ -3391,12 +3687,14 @@ export interface GetGeofenceResponse {
3391
3687
  */
3392
3688
  export interface ListGeofenceCollectionsRequest {
3393
3689
  /**
3690
+ * @public
3394
3691
  * <p>An optional limit for the number of resources returned in a single call. </p>
3395
3692
  * <p>Default value: <code>100</code>
3396
3693
  * </p>
3397
3694
  */
3398
3695
  MaxResults?: number;
3399
3696
  /**
3697
+ * @public
3400
3698
  * <p>The pagination token specifying which page of results to return in the response. If no
3401
3699
  * token is provided, the default page is the first page. </p>
3402
3700
  * <p>Default value: <code>null</code>
@@ -3410,32 +3708,38 @@ export interface ListGeofenceCollectionsRequest {
3410
3708
  */
3411
3709
  export interface ListGeofenceCollectionsResponseEntry {
3412
3710
  /**
3711
+ * @public
3413
3712
  * <p>The name of the geofence collection.</p>
3414
3713
  */
3415
3714
  CollectionName: string | undefined;
3416
3715
  /**
3716
+ * @public
3417
3717
  * <p>The description for the geofence collection</p>
3418
3718
  */
3419
3719
  Description: string | undefined;
3420
3720
  /**
3721
+ * @public
3421
3722
  * @deprecated
3422
3723
  *
3423
3724
  * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
3424
3725
  */
3425
3726
  PricingPlan?: PricingPlan | string;
3426
3727
  /**
3728
+ * @public
3427
3729
  * @deprecated
3428
3730
  *
3429
3731
  * <p>No longer used. Always returns an empty string.</p>
3430
3732
  */
3431
3733
  PricingPlanDataSource?: string;
3432
3734
  /**
3735
+ * @public
3433
3736
  * <p>The timestamp for when the geofence collection was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3434
3737
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3435
3738
  * </p>
3436
3739
  */
3437
3740
  CreateTime: Date | undefined;
3438
3741
  /**
3742
+ * @public
3439
3743
  * <p>Specifies a timestamp for when the resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3440
3744
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3441
3745
  * </p>
@@ -3447,10 +3751,12 @@ export interface ListGeofenceCollectionsResponseEntry {
3447
3751
  */
3448
3752
  export interface ListGeofenceCollectionsResponse {
3449
3753
  /**
3754
+ * @public
3450
3755
  * <p>Lists the geofence collections that exist in your Amazon Web Services account.</p>
3451
3756
  */
3452
3757
  Entries: ListGeofenceCollectionsResponseEntry[] | undefined;
3453
3758
  /**
3759
+ * @public
3454
3760
  * <p>A pagination token indicating there are additional pages available. You can use the
3455
3761
  * token in a following request to fetch the next set of results. </p>
3456
3762
  */
@@ -3461,10 +3767,12 @@ export interface ListGeofenceCollectionsResponse {
3461
3767
  */
3462
3768
  export interface ListGeofencesRequest {
3463
3769
  /**
3770
+ * @public
3464
3771
  * <p>The name of the geofence collection storing the list of geofences.</p>
3465
3772
  */
3466
3773
  CollectionName: string | undefined;
3467
3774
  /**
3775
+ * @public
3468
3776
  * <p>The pagination token specifying which page of results to return in the response. If no
3469
3777
  * token is provided, the default page is the first page. </p>
3470
3778
  * <p>Default value: <code>null</code>
@@ -3472,6 +3780,7 @@ export interface ListGeofencesRequest {
3472
3780
  */
3473
3781
  NextToken?: string;
3474
3782
  /**
3783
+ * @public
3475
3784
  * <p>An optional limit for the number of geofences returned in a single call. </p>
3476
3785
  * <p>Default value: <code>100</code>
3477
3786
  * </p>
@@ -3484,14 +3793,17 @@ export interface ListGeofencesRequest {
3484
3793
  */
3485
3794
  export interface ListGeofenceResponseEntry {
3486
3795
  /**
3796
+ * @public
3487
3797
  * <p>The geofence identifier.</p>
3488
3798
  */
3489
3799
  GeofenceId: string | undefined;
3490
3800
  /**
3801
+ * @public
3491
3802
  * <p>Contains the geofence geometry details describing a polygon or a circle.</p>
3492
3803
  */
3493
3804
  Geometry: GeofenceGeometry | undefined;
3494
3805
  /**
3806
+ * @public
3495
3807
  * <p>Identifies the state of the geofence. A geofence will hold one of the following
3496
3808
  * states:</p>
3497
3809
  * <ul>
@@ -3521,18 +3833,21 @@ export interface ListGeofenceResponseEntry {
3521
3833
  */
3522
3834
  Status: string | undefined;
3523
3835
  /**
3836
+ * @public
3524
3837
  * <p>The timestamp for when the geofence was stored in a geofence collection in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3525
3838
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3526
3839
  * </p>
3527
3840
  */
3528
3841
  CreateTime: Date | undefined;
3529
3842
  /**
3843
+ * @public
3530
3844
  * <p>The timestamp for when the geofence was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3531
3845
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3532
3846
  * </p>
3533
3847
  */
3534
3848
  UpdateTime: Date | undefined;
3535
3849
  /**
3850
+ * @public
3536
3851
  * <p>User defined properties of the geofence. A property is a key-value
3537
3852
  * pair stored with the geofence and added to any geofence event triggered with that
3538
3853
  * geofence.</p>
@@ -3546,10 +3861,12 @@ export interface ListGeofenceResponseEntry {
3546
3861
  */
3547
3862
  export interface ListGeofencesResponse {
3548
3863
  /**
3864
+ * @public
3549
3865
  * <p>Contains a list of geofences stored in the geofence collection.</p>
3550
3866
  */
3551
3867
  Entries: ListGeofenceResponseEntry[] | undefined;
3552
3868
  /**
3869
+ * @public
3553
3870
  * <p>A pagination token indicating there are additional pages available. You can use the
3554
3871
  * token in a following request to fetch the next set of results. </p>
3555
3872
  */
@@ -3560,14 +3877,17 @@ export interface ListGeofencesResponse {
3560
3877
  */
3561
3878
  export interface PutGeofenceRequest {
3562
3879
  /**
3880
+ * @public
3563
3881
  * <p>The geofence collection to store the geofence in.</p>
3564
3882
  */
3565
3883
  CollectionName: string | undefined;
3566
3884
  /**
3885
+ * @public
3567
3886
  * <p>An identifier for the geofence. For example, <code>ExampleGeofence-1</code>.</p>
3568
3887
  */
3569
3888
  GeofenceId: string | undefined;
3570
3889
  /**
3890
+ * @public
3571
3891
  * <p>Contains the details to specify the position of the geofence. Can be either a
3572
3892
  * polygon or a circle. Including both will return a validation error.</p>
3573
3893
  * <note>
@@ -3577,6 +3897,7 @@ export interface PutGeofenceRequest {
3577
3897
  */
3578
3898
  Geometry: GeofenceGeometry | undefined;
3579
3899
  /**
3900
+ * @public
3580
3901
  * <p>Associates one of more properties with the geofence. A property is a key-value
3581
3902
  * pair stored with the geofence and added to any geofence event triggered with that
3582
3903
  * geofence.</p>
@@ -3590,16 +3911,19 @@ export interface PutGeofenceRequest {
3590
3911
  */
3591
3912
  export interface PutGeofenceResponse {
3592
3913
  /**
3914
+ * @public
3593
3915
  * <p>The geofence identifier entered in the request.</p>
3594
3916
  */
3595
3917
  GeofenceId: string | undefined;
3596
3918
  /**
3919
+ * @public
3597
3920
  * <p>The timestamp for when the geofence was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3598
3921
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3599
3922
  * </p>
3600
3923
  */
3601
3924
  CreateTime: Date | undefined;
3602
3925
  /**
3926
+ * @public
3603
3927
  * <p>The timestamp for when the geofence was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3604
3928
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3605
3929
  * </p>
@@ -3611,10 +3935,12 @@ export interface PutGeofenceResponse {
3611
3935
  */
3612
3936
  export interface UpdateGeofenceCollectionRequest {
3613
3937
  /**
3938
+ * @public
3614
3939
  * <p>The name of the geofence collection to update.</p>
3615
3940
  */
3616
3941
  CollectionName: string | undefined;
3617
3942
  /**
3943
+ * @public
3618
3944
  * @deprecated
3619
3945
  *
3620
3946
  * <p>No longer used. If included, the only allowed value is
@@ -3622,12 +3948,14 @@ export interface UpdateGeofenceCollectionRequest {
3622
3948
  */
3623
3949
  PricingPlan?: PricingPlan | string;
3624
3950
  /**
3951
+ * @public
3625
3952
  * @deprecated
3626
3953
  *
3627
3954
  * <p>This parameter is no longer used.</p>
3628
3955
  */
3629
3956
  PricingPlanDataSource?: string;
3630
3957
  /**
3958
+ * @public
3631
3959
  * <p>Updates the description for the geofence collection.</p>
3632
3960
  */
3633
3961
  Description?: string;
@@ -3637,10 +3965,12 @@ export interface UpdateGeofenceCollectionRequest {
3637
3965
  */
3638
3966
  export interface UpdateGeofenceCollectionResponse {
3639
3967
  /**
3968
+ * @public
3640
3969
  * <p>The name of the updated geofence collection.</p>
3641
3970
  */
3642
3971
  CollectionName: string | undefined;
3643
3972
  /**
3973
+ * @public
3644
3974
  * <p>The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a
3645
3975
  * resource across Amazon Web Services.</p>
3646
3976
  * <ul>
@@ -3653,6 +3983,7 @@ export interface UpdateGeofenceCollectionResponse {
3653
3983
  */
3654
3984
  CollectionArn: string | undefined;
3655
3985
  /**
3986
+ * @public
3656
3987
  * <p>The time when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3657
3988
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
3658
3989
  * </p>
@@ -3664,10 +3995,12 @@ export interface UpdateGeofenceCollectionResponse {
3664
3995
  */
3665
3996
  export interface GetDevicePositionRequest {
3666
3997
  /**
3998
+ * @public
3667
3999
  * <p>The tracker resource receiving the position update.</p>
3668
4000
  */
3669
4001
  TrackerName: string | undefined;
3670
4002
  /**
4003
+ * @public
3671
4004
  * <p>The device whose position you want to retrieve.</p>
3672
4005
  */
3673
4006
  DeviceId: string | undefined;
@@ -3677,28 +4010,34 @@ export interface GetDevicePositionRequest {
3677
4010
  */
3678
4011
  export interface GetDevicePositionResponse {
3679
4012
  /**
4013
+ * @public
3680
4014
  * <p>The device whose position you retrieved.</p>
3681
4015
  */
3682
4016
  DeviceId?: string;
3683
4017
  /**
4018
+ * @public
3684
4019
  * <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601 </a>
3685
4020
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3686
4021
  */
3687
4022
  SampleTime: Date | undefined;
3688
4023
  /**
4024
+ * @public
3689
4025
  * <p>The timestamp for when the tracker resource received the device position in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601 </a>
3690
4026
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3691
4027
  */
3692
4028
  ReceivedTime: Date | undefined;
3693
4029
  /**
4030
+ * @public
3694
4031
  * <p>The last known device position.</p>
3695
4032
  */
3696
4033
  Position: number[] | undefined;
3697
4034
  /**
4035
+ * @public
3698
4036
  * <p>The accuracy of the device position.</p>
3699
4037
  */
3700
4038
  Accuracy?: PositionalAccuracy;
3701
4039
  /**
4040
+ * @public
3702
4041
  * <p>The properties associated with the position.</p>
3703
4042
  */
3704
4043
  PositionProperties?: Record<string, string>;
@@ -3708,14 +4047,17 @@ export interface GetDevicePositionResponse {
3708
4047
  */
3709
4048
  export interface GetDevicePositionHistoryRequest {
3710
4049
  /**
4050
+ * @public
3711
4051
  * <p>The tracker resource receiving the request for the device position history.</p>
3712
4052
  */
3713
4053
  TrackerName: string | undefined;
3714
4054
  /**
4055
+ * @public
3715
4056
  * <p>The device whose position history you want to retrieve.</p>
3716
4057
  */
3717
4058
  DeviceId: string | undefined;
3718
4059
  /**
4060
+ * @public
3719
4061
  * <p>The pagination token specifying which page of results to return in the response. If no
3720
4062
  * token is provided, the default page is the first page. </p>
3721
4063
  * <p>Default value: <code>null</code>
@@ -3723,6 +4065,7 @@ export interface GetDevicePositionHistoryRequest {
3723
4065
  */
3724
4066
  NextToken?: string;
3725
4067
  /**
4068
+ * @public
3726
4069
  * <p>Specify the start time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
3727
4070
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be 24 hours
3728
4071
  * prior to the time that the request is made.</p>
@@ -3736,6 +4079,7 @@ export interface GetDevicePositionHistoryRequest {
3736
4079
  */
3737
4080
  StartTimeInclusive?: Date;
3738
4081
  /**
4082
+ * @public
3739
4083
  * <p>Specify the end time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
3740
4084
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be the time
3741
4085
  * that the request is made.</p>
@@ -3749,6 +4093,7 @@ export interface GetDevicePositionHistoryRequest {
3749
4093
  */
3750
4094
  EndTimeExclusive?: Date;
3751
4095
  /**
4096
+ * @public
3752
4097
  * <p>An optional limit for the number of device positions returned in a single call.</p>
3753
4098
  * <p>Default value: <code>100</code>
3754
4099
  * </p>
@@ -3760,10 +4105,12 @@ export interface GetDevicePositionHistoryRequest {
3760
4105
  */
3761
4106
  export interface GetDevicePositionHistoryResponse {
3762
4107
  /**
4108
+ * @public
3763
4109
  * <p>Contains the position history details for the requested device.</p>
3764
4110
  */
3765
4111
  DevicePositions: DevicePosition[] | undefined;
3766
4112
  /**
4113
+ * @public
3767
4114
  * <p>A pagination token indicating there are additional pages available. You can use the
3768
4115
  * token in a following request to fetch the next set of results.</p>
3769
4116
  */
@@ -3774,10 +4121,12 @@ export interface GetDevicePositionHistoryResponse {
3774
4121
  */
3775
4122
  export interface GetMapGlyphsRequest {
3776
4123
  /**
4124
+ * @public
3777
4125
  * <p>The map resource associated with the glyph file.</p>
3778
4126
  */
3779
4127
  MapName: string | undefined;
3780
4128
  /**
4129
+ * @public
3781
4130
  * <p>A comma-separated list of fonts to load glyphs from in order of preference. For
3782
4131
  * example, <code>Noto Sans Regular, Arial Unicode</code>.</p>
3783
4132
  * <p>Valid fonts stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a> styles: </p>
@@ -3867,12 +4216,14 @@ export interface GetMapGlyphsRequest {
3867
4216
  */
3868
4217
  FontStack: string | undefined;
3869
4218
  /**
4219
+ * @public
3870
4220
  * <p>A Unicode range of characters to download glyphs for. Each response will contain 256
3871
4221
  * characters. For example, 0–255 includes all characters from range <code>U+0000</code> to
3872
4222
  * <code>00FF</code>. Must be aligned to multiples of 256.</p>
3873
4223
  */
3874
4224
  FontUnicodeRange: string | undefined;
3875
4225
  /**
4226
+ * @public
3876
4227
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
3877
4228
  * the request.</p>
3878
4229
  */
@@ -3883,14 +4234,17 @@ export interface GetMapGlyphsRequest {
3883
4234
  */
3884
4235
  export interface GetMapGlyphsResponse {
3885
4236
  /**
4237
+ * @public
3886
4238
  * <p>The glyph, as binary blob.</p>
3887
4239
  */
3888
4240
  Blob?: Uint8Array;
3889
4241
  /**
4242
+ * @public
3890
4243
  * <p>The map glyph content type. For example, <code>application/octet-stream</code>.</p>
3891
4244
  */
3892
4245
  ContentType?: string;
3893
4246
  /**
4247
+ * @public
3894
4248
  * <p>The HTTP Cache-Control directive for the value.</p>
3895
4249
  */
3896
4250
  CacheControl?: string;
@@ -3900,10 +4254,12 @@ export interface GetMapGlyphsResponse {
3900
4254
  */
3901
4255
  export interface GetMapSpritesRequest {
3902
4256
  /**
4257
+ * @public
3903
4258
  * <p>The map resource associated with the sprite file.</p>
3904
4259
  */
3905
4260
  MapName: string | undefined;
3906
4261
  /**
4262
+ * @public
3907
4263
  * <p>The name of the sprite file. Use the following file names for the sprite sheet:</p>
3908
4264
  * <ul>
3909
4265
  * <li>
@@ -3931,6 +4287,7 @@ export interface GetMapSpritesRequest {
3931
4287
  */
3932
4288
  FileName: string | undefined;
3933
4289
  /**
4290
+ * @public
3934
4291
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
3935
4292
  * the request.</p>
3936
4293
  */
@@ -3941,16 +4298,19 @@ export interface GetMapSpritesRequest {
3941
4298
  */
3942
4299
  export interface GetMapSpritesResponse {
3943
4300
  /**
4301
+ * @public
3944
4302
  * <p>Contains the body of the sprite sheet or JSON offset file.</p>
3945
4303
  */
3946
4304
  Blob?: Uint8Array;
3947
4305
  /**
4306
+ * @public
3948
4307
  * <p>The content type of the sprite sheet and offsets. For example, the sprite sheet
3949
4308
  * content type is <code>image/png</code>, and the sprite offset JSON document is
3950
4309
  * <code>application/json</code>. </p>
3951
4310
  */
3952
4311
  ContentType?: string;
3953
4312
  /**
4313
+ * @public
3954
4314
  * <p>The HTTP Cache-Control directive for the value.</p>
3955
4315
  */
3956
4316
  CacheControl?: string;
@@ -3960,10 +4320,12 @@ export interface GetMapSpritesResponse {
3960
4320
  */
3961
4321
  export interface GetMapStyleDescriptorRequest {
3962
4322
  /**
4323
+ * @public
3963
4324
  * <p>The map resource to retrieve the style descriptor from.</p>
3964
4325
  */
3965
4326
  MapName: string | undefined;
3966
4327
  /**
4328
+ * @public
3967
4329
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
3968
4330
  * the request.</p>
3969
4331
  */
@@ -3974,15 +4336,18 @@ export interface GetMapStyleDescriptorRequest {
3974
4336
  */
3975
4337
  export interface GetMapStyleDescriptorResponse {
3976
4338
  /**
4339
+ * @public
3977
4340
  * <p>Contains the body of the style descriptor.</p>
3978
4341
  */
3979
4342
  Blob?: Uint8Array;
3980
4343
  /**
4344
+ * @public
3981
4345
  * <p>The style descriptor's content type. For example,
3982
4346
  * <code>application/json</code>.</p>
3983
4347
  */
3984
4348
  ContentType?: string;
3985
4349
  /**
4350
+ * @public
3986
4351
  * <p>The HTTP Cache-Control directive for the value.</p>
3987
4352
  */
3988
4353
  CacheControl?: string;
@@ -3992,22 +4357,27 @@ export interface GetMapStyleDescriptorResponse {
3992
4357
  */
3993
4358
  export interface GetMapTileRequest {
3994
4359
  /**
4360
+ * @public
3995
4361
  * <p>The map resource to retrieve the map tiles from.</p>
3996
4362
  */
3997
4363
  MapName: string | undefined;
3998
4364
  /**
4365
+ * @public
3999
4366
  * <p>The zoom value for the map tile.</p>
4000
4367
  */
4001
4368
  Z: string | undefined;
4002
4369
  /**
4370
+ * @public
4003
4371
  * <p>The X axis value for the map tile.</p>
4004
4372
  */
4005
4373
  X: string | undefined;
4006
4374
  /**
4375
+ * @public
4007
4376
  * <p>The Y axis value for the map tile. </p>
4008
4377
  */
4009
4378
  Y: string | undefined;
4010
4379
  /**
4380
+ * @public
4011
4381
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
4012
4382
  * the request.</p>
4013
4383
  */
@@ -4018,15 +4388,18 @@ export interface GetMapTileRequest {
4018
4388
  */
4019
4389
  export interface GetMapTileResponse {
4020
4390
  /**
4391
+ * @public
4021
4392
  * <p>Contains Mapbox Vector Tile (MVT) data.</p>
4022
4393
  */
4023
4394
  Blob?: Uint8Array;
4024
4395
  /**
4396
+ * @public
4025
4397
  * <p>The map tile's content type. For example,
4026
4398
  * <code>application/vnd.mapbox-vector-tile</code>.</p>
4027
4399
  */
4028
4400
  ContentType?: string;
4029
4401
  /**
4402
+ * @public
4030
4403
  * <p>The HTTP Cache-Control directive for the value.</p>
4031
4404
  */
4032
4405
  CacheControl?: string;
@@ -4036,14 +4409,17 @@ export interface GetMapTileResponse {
4036
4409
  */
4037
4410
  export interface GetPlaceRequest {
4038
4411
  /**
4412
+ * @public
4039
4413
  * <p>The name of the place index resource that you want to use for the search.</p>
4040
4414
  */
4041
4415
  IndexName: string | undefined;
4042
4416
  /**
4417
+ * @public
4043
4418
  * <p>The identifier of the place to find.</p>
4044
4419
  */
4045
4420
  PlaceId: string | undefined;
4046
4421
  /**
4422
+ * @public
4047
4423
  * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
4048
4424
  * <code>en</code> for English.</p>
4049
4425
  * <p>This setting affects the languages used in the results, but not the results
@@ -4061,6 +4437,7 @@ export interface GetPlaceRequest {
4061
4437
  */
4062
4438
  Language?: string;
4063
4439
  /**
4440
+ * @public
4064
4441
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
4065
4442
  * the request.</p>
4066
4443
  */
@@ -4072,6 +4449,7 @@ export interface GetPlaceRequest {
4072
4449
  */
4073
4450
  export interface PlaceGeometry {
4074
4451
  /**
4452
+ * @public
4075
4453
  * <p>A single point geometry specifies a location for a Place using <a href="https://gisgeography.com/wgs84-world-geodetic-system/">WGS 84</a>
4076
4454
  * coordinates:</p>
4077
4455
  * <ul>
@@ -4094,12 +4472,14 @@ export interface PlaceGeometry {
4094
4472
  */
4095
4473
  export interface TimeZone {
4096
4474
  /**
4475
+ * @public
4097
4476
  * <p>The name of the time zone, following the <a href="https://www.iana.org/time-zones">
4098
4477
  * IANA time zone standard</a>. For example,
4099
4478
  * <code>America/Los_Angeles</code>.</p>
4100
4479
  */
4101
4480
  Name: string | undefined;
4102
4481
  /**
4482
+ * @public
4103
4483
  * <p>The time zone's offset, in seconds, from UTC.</p>
4104
4484
  */
4105
4485
  Offset?: number;
@@ -4113,53 +4493,64 @@ export interface TimeZone {
4113
4493
  */
4114
4494
  export interface Place {
4115
4495
  /**
4496
+ * @public
4116
4497
  * <p>The full name and address of the point of interest such as a city, region, or country.
4117
4498
  * For example, <code>123 Any Street, Any Town, USA</code>.</p>
4118
4499
  */
4119
4500
  Label?: string;
4120
4501
  /**
4502
+ * @public
4121
4503
  * <p>Places uses a point geometry to specify a location or a Place.</p>
4122
4504
  */
4123
4505
  Geometry: PlaceGeometry | undefined;
4124
4506
  /**
4507
+ * @public
4125
4508
  * <p>The numerical portion of an address, such as a building number. </p>
4126
4509
  */
4127
4510
  AddressNumber?: string;
4128
4511
  /**
4512
+ * @public
4129
4513
  * <p>The name for a street or a road to identify a location. For example, <code>Main
4130
4514
  * Street</code>.</p>
4131
4515
  */
4132
4516
  Street?: string;
4133
4517
  /**
4518
+ * @public
4134
4519
  * <p>The name of a community district. For example, <code>Downtown</code>.</p>
4135
4520
  */
4136
4521
  Neighborhood?: string;
4137
4522
  /**
4523
+ * @public
4138
4524
  * <p>A name for a local area, such as a city or town name. For example,
4139
4525
  * <code>Toronto</code>.</p>
4140
4526
  */
4141
4527
  Municipality?: string;
4142
4528
  /**
4529
+ * @public
4143
4530
  * <p>A county, or an area that's part of a larger region. For example, <code>Metro
4144
4531
  * Vancouver</code>.</p>
4145
4532
  */
4146
4533
  SubRegion?: string;
4147
4534
  /**
4535
+ * @public
4148
4536
  * <p>A name for an area or geographical division, such as a province or state name. For
4149
4537
  * example, <code>British Columbia</code>.</p>
4150
4538
  */
4151
4539
  Region?: string;
4152
4540
  /**
4541
+ * @public
4153
4542
  * <p>A country/region specified using <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
4154
4543
  * country/region code. For example, <code>CAN</code>.</p>
4155
4544
  */
4156
4545
  Country?: string;
4157
4546
  /**
4547
+ * @public
4158
4548
  * <p>A group of numbers and letters in a country-specific format, which accompanies the
4159
4549
  * address for the purpose of identifying a location. </p>
4160
4550
  */
4161
4551
  PostalCode?: string;
4162
4552
  /**
4553
+ * @public
4163
4554
  * <p>
4164
4555
  * <code>True</code> if the result is interpolated from other known places.</p>
4165
4556
  * <p>
@@ -4172,11 +4563,13 @@ export interface Place {
4172
4563
  */
4173
4564
  Interpolated?: boolean;
4174
4565
  /**
4566
+ * @public
4175
4567
  * <p>The time zone in which the <code>Place</code> is located. Returned only when using
4176
4568
  * HERE or Grab as the selected partner.</p>
4177
4569
  */
4178
4570
  TimeZone?: TimeZone;
4179
4571
  /**
4572
+ * @public
4180
4573
  * <p>For addresses with a <code>UnitNumber</code>, the type of unit. For example,
4181
4574
  * <code>Apartment</code>.</p>
4182
4575
  * <note>
@@ -4185,6 +4578,7 @@ export interface Place {
4185
4578
  */
4186
4579
  UnitType?: string;
4187
4580
  /**
4581
+ * @public
4188
4582
  * <p>For addresses with multiple units, the unit identifier. Can include numbers and
4189
4583
  * letters, for example <code>3B</code> or <code>Unit 123</code>.</p>
4190
4584
  * <note>
@@ -4194,6 +4588,7 @@ export interface Place {
4194
4588
  */
4195
4589
  UnitNumber?: string;
4196
4590
  /**
4591
+ * @public
4197
4592
  * <p>The Amazon Location categories that describe this Place.</p>
4198
4593
  * <p>For more information about using categories, including a list of Amazon Location
4199
4594
  * categories, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html">Categories and filtering</a>, in the <i>Amazon Location Service Developer
@@ -4201,6 +4596,7 @@ export interface Place {
4201
4596
  */
4202
4597
  Categories?: string[];
4203
4598
  /**
4599
+ * @public
4204
4600
  * <p>Categories from the data provider that describe the Place that are not mapped
4205
4601
  * to any Amazon Location categories.</p>
4206
4602
  */
@@ -4211,6 +4607,7 @@ export interface Place {
4211
4607
  */
4212
4608
  export interface GetPlaceResponse {
4213
4609
  /**
4610
+ * @public
4214
4611
  * <p>Details about the result, such as its address and position.</p>
4215
4612
  */
4216
4613
  Place: Place | undefined;
@@ -4220,16 +4617,19 @@ export interface GetPlaceResponse {
4220
4617
  */
4221
4618
  export interface ListDevicePositionsRequest {
4222
4619
  /**
4620
+ * @public
4223
4621
  * <p>The tracker resource containing the requested devices.</p>
4224
4622
  */
4225
4623
  TrackerName: string | undefined;
4226
4624
  /**
4625
+ * @public
4227
4626
  * <p>An optional limit for the number of entries returned in a single call.</p>
4228
4627
  * <p>Default value: <code>100</code>
4229
4628
  * </p>
4230
4629
  */
4231
4630
  MaxResults?: number;
4232
4631
  /**
4632
+ * @public
4233
4633
  * <p>The pagination token specifying which page of results to return in the response. If no
4234
4634
  * token is provided, the default page is the first page.</p>
4235
4635
  * <p>Default value: <code>null</code>
@@ -4243,23 +4643,28 @@ export interface ListDevicePositionsRequest {
4243
4643
  */
4244
4644
  export interface ListDevicePositionsResponseEntry {
4245
4645
  /**
4646
+ * @public
4246
4647
  * <p>The ID of the device for this position.</p>
4247
4648
  */
4248
4649
  DeviceId: string | undefined;
4249
4650
  /**
4651
+ * @public
4250
4652
  * <p>The timestamp at which the device position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
4251
4653
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
4252
4654
  */
4253
4655
  SampleTime: Date | undefined;
4254
4656
  /**
4657
+ * @public
4255
4658
  * <p>The last known device position. Empty if no positions currently stored.</p>
4256
4659
  */
4257
4660
  Position: number[] | undefined;
4258
4661
  /**
4662
+ * @public
4259
4663
  * <p>The accuracy of the device position.</p>
4260
4664
  */
4261
4665
  Accuracy?: PositionalAccuracy;
4262
4666
  /**
4667
+ * @public
4263
4668
  * <p>The properties associated with the position.</p>
4264
4669
  */
4265
4670
  PositionProperties?: Record<string, string>;
@@ -4269,11 +4674,13 @@ export interface ListDevicePositionsResponseEntry {
4269
4674
  */
4270
4675
  export interface ListDevicePositionsResponse {
4271
4676
  /**
4677
+ * @public
4272
4678
  * <p>Contains details about each device's last known position. These details includes the device ID,
4273
4679
  * the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.</p>
4274
4680
  */
4275
4681
  Entries: ListDevicePositionsResponseEntry[] | undefined;
4276
4682
  /**
4683
+ * @public
4277
4684
  * <p>A pagination token indicating there are additional pages available. You can use the
4278
4685
  * token in a following request to fetch the next set of results.</p>
4279
4686
  */
@@ -4284,12 +4691,14 @@ export interface ListDevicePositionsResponse {
4284
4691
  */
4285
4692
  export interface ListMapsRequest {
4286
4693
  /**
4694
+ * @public
4287
4695
  * <p>An optional limit for the number of resources returned in a single call. </p>
4288
4696
  * <p>Default value: <code>100</code>
4289
4697
  * </p>
4290
4698
  */
4291
4699
  MaxResults?: number;
4292
4700
  /**
4701
+ * @public
4293
4702
  * <p>The pagination token specifying which page of results to return in the response. If no
4294
4703
  * token is provided, the default page is the first page.</p>
4295
4704
  * <p>Default value: <code>null</code>
@@ -4303,29 +4712,35 @@ export interface ListMapsRequest {
4303
4712
  */
4304
4713
  export interface ListMapsResponseEntry {
4305
4714
  /**
4715
+ * @public
4306
4716
  * <p>The name of the associated map resource.</p>
4307
4717
  */
4308
4718
  MapName: string | undefined;
4309
4719
  /**
4720
+ * @public
4310
4721
  * <p>The description for the map resource.</p>
4311
4722
  */
4312
4723
  Description: string | undefined;
4313
4724
  /**
4725
+ * @public
4314
4726
  * <p>Specifies the data provider for the associated map tiles.</p>
4315
4727
  */
4316
4728
  DataSource: string | undefined;
4317
4729
  /**
4730
+ * @public
4318
4731
  * @deprecated
4319
4732
  *
4320
4733
  * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
4321
4734
  */
4322
4735
  PricingPlan?: PricingPlan | string;
4323
4736
  /**
4737
+ * @public
4324
4738
  * <p>The timestamp for when the map resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
4325
4739
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
4326
4740
  */
4327
4741
  CreateTime: Date | undefined;
4328
4742
  /**
4743
+ * @public
4329
4744
  * <p>The timestamp for when the map resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
4330
4745
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
4331
4746
  */
@@ -4336,10 +4751,12 @@ export interface ListMapsResponseEntry {
4336
4751
  */
4337
4752
  export interface ListMapsResponse {
4338
4753
  /**
4754
+ * @public
4339
4755
  * <p>Contains a list of maps in your Amazon Web Services account</p>
4340
4756
  */
4341
4757
  Entries: ListMapsResponseEntry[] | undefined;
4342
4758
  /**
4759
+ * @public
4343
4760
  * <p>A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results. </p>
4344
4761
  */
4345
4762
  NextToken?: string;
@@ -4349,12 +4766,14 @@ export interface ListMapsResponse {
4349
4766
  */
4350
4767
  export interface ListPlaceIndexesRequest {
4351
4768
  /**
4769
+ * @public
4352
4770
  * <p>An optional limit for the maximum number of results returned in a single call.</p>
4353
4771
  * <p>Default value: <code>100</code>
4354
4772
  * </p>
4355
4773
  */
4356
4774
  MaxResults?: number;
4357
4775
  /**
4776
+ * @public
4358
4777
  * <p>The pagination token specifying which page of results to return in the response. If no
4359
4778
  * token is provided, the default page is the first page.</p>
4360
4779
  * <p>Default value: <code>null</code>
@@ -4368,14 +4787,17 @@ export interface ListPlaceIndexesRequest {
4368
4787
  */
4369
4788
  export interface ListPlaceIndexesResponseEntry {
4370
4789
  /**
4790
+ * @public
4371
4791
  * <p>The name of the place index resource.</p>
4372
4792
  */
4373
4793
  IndexName: string | undefined;
4374
4794
  /**
4795
+ * @public
4375
4796
  * <p>The optional description for the place index resource.</p>
4376
4797
  */
4377
4798
  Description: string | undefined;
4378
4799
  /**
4800
+ * @public
4379
4801
  * <p>The data provider of geospatial data. Values can be one of the following:</p>
4380
4802
  * <ul>
4381
4803
  * <li>
@@ -4398,17 +4820,20 @@ export interface ListPlaceIndexesResponseEntry {
4398
4820
  */
4399
4821
  DataSource: string | undefined;
4400
4822
  /**
4823
+ * @public
4401
4824
  * @deprecated
4402
4825
  *
4403
4826
  * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
4404
4827
  */
4405
4828
  PricingPlan?: PricingPlan | string;
4406
4829
  /**
4830
+ * @public
4407
4831
  * <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
4408
4832
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4409
4833
  */
4410
4834
  CreateTime: Date | undefined;
4411
4835
  /**
4836
+ * @public
4412
4837
  * <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
4413
4838
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4414
4839
  */
@@ -4419,10 +4844,12 @@ export interface ListPlaceIndexesResponseEntry {
4419
4844
  */
4420
4845
  export interface ListPlaceIndexesResponse {
4421
4846
  /**
4847
+ * @public
4422
4848
  * <p>Lists the place index resources that exist in your Amazon Web Services account</p>
4423
4849
  */
4424
4850
  Entries: ListPlaceIndexesResponseEntry[] | undefined;
4425
4851
  /**
4852
+ * @public
4426
4853
  * <p>A pagination token indicating that there are additional pages available. You can use
4427
4854
  * the token in a new request to fetch the next page of results.</p>
4428
4855
  */
@@ -4433,12 +4860,14 @@ export interface ListPlaceIndexesResponse {
4433
4860
  */
4434
4861
  export interface ListRouteCalculatorsRequest {
4435
4862
  /**
4863
+ * @public
4436
4864
  * <p>An optional maximum number of results returned in a single call.</p>
4437
4865
  * <p>Default Value: <code>100</code>
4438
4866
  * </p>
4439
4867
  */
4440
4868
  MaxResults?: number;
4441
4869
  /**
4870
+ * @public
4442
4871
  * <p>The pagination token specifying which page of results to return in the response. If no
4443
4872
  * token is provided, the default page is the first page.</p>
4444
4873
  * <p>Default Value: <code>null</code>
@@ -4452,14 +4881,17 @@ export interface ListRouteCalculatorsRequest {
4452
4881
  */
4453
4882
  export interface ListRouteCalculatorsResponseEntry {
4454
4883
  /**
4884
+ * @public
4455
4885
  * <p>The name of the route calculator resource.</p>
4456
4886
  */
4457
4887
  CalculatorName: string | undefined;
4458
4888
  /**
4889
+ * @public
4459
4890
  * <p>The optional description of the route calculator resource.</p>
4460
4891
  */
4461
4892
  Description: string | undefined;
4462
4893
  /**
4894
+ * @public
4463
4895
  * <p>The data provider of traffic and road network data. Indicates one of the available
4464
4896
  * providers:</p>
4465
4897
  * <ul>
@@ -4483,12 +4915,14 @@ export interface ListRouteCalculatorsResponseEntry {
4483
4915
  */
4484
4916
  DataSource: string | undefined;
4485
4917
  /**
4918
+ * @public
4486
4919
  * @deprecated
4487
4920
  *
4488
4921
  * <p>Always returns <code>RequestBasedUsage</code>.</p>
4489
4922
  */
4490
4923
  PricingPlan?: PricingPlan | string;
4491
4924
  /**
4925
+ * @public
4492
4926
  * <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
4493
4927
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4494
4928
  * <ul>
@@ -4500,6 +4934,7 @@ export interface ListRouteCalculatorsResponseEntry {
4500
4934
  */
4501
4935
  CreateTime: Date | undefined;
4502
4936
  /**
4937
+ * @public
4503
4938
  * <p>The timestamp when the route calculator resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
4504
4939
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4505
4940
  * <ul>
@@ -4516,10 +4951,12 @@ export interface ListRouteCalculatorsResponseEntry {
4516
4951
  */
4517
4952
  export interface ListRouteCalculatorsResponse {
4518
4953
  /**
4954
+ * @public
4519
4955
  * <p>Lists the route calculator resources that exist in your Amazon Web Services account</p>
4520
4956
  */
4521
4957
  Entries: ListRouteCalculatorsResponseEntry[] | undefined;
4522
4958
  /**
4959
+ * @public
4523
4960
  * <p>A pagination token indicating there are additional pages available. You can use the
4524
4961
  * token in a subsequent request to fetch the next set of results.</p>
4525
4962
  */
@@ -4530,16 +4967,19 @@ export interface ListRouteCalculatorsResponse {
4530
4967
  */
4531
4968
  export interface ListTrackerConsumersRequest {
4532
4969
  /**
4970
+ * @public
4533
4971
  * <p>The tracker resource whose associated geofence collections you want to list.</p>
4534
4972
  */
4535
4973
  TrackerName: string | undefined;
4536
4974
  /**
4975
+ * @public
4537
4976
  * <p>An optional limit for the number of resources returned in a single call. </p>
4538
4977
  * <p>Default value: <code>100</code>
4539
4978
  * </p>
4540
4979
  */
4541
4980
  MaxResults?: number;
4542
4981
  /**
4982
+ * @public
4543
4983
  * <p>The pagination token specifying which page of results to return in the response. If no
4544
4984
  * token is provided, the default page is the first page. </p>
4545
4985
  * <p>Default value: <code>null</code>
@@ -4552,10 +4992,12 @@ export interface ListTrackerConsumersRequest {
4552
4992
  */
4553
4993
  export interface ListTrackerConsumersResponse {
4554
4994
  /**
4995
+ * @public
4555
4996
  * <p>Contains the list of geofence collection ARNs associated to the tracker resource.</p>
4556
4997
  */
4557
4998
  ConsumerArns: string[] | undefined;
4558
4999
  /**
5000
+ * @public
4559
5001
  * <p>A pagination token indicating there are additional pages available. You can use the
4560
5002
  * token in a following request to fetch the next set of results. </p>
4561
5003
  */
@@ -4566,12 +5008,14 @@ export interface ListTrackerConsumersResponse {
4566
5008
  */
4567
5009
  export interface ListTrackersRequest {
4568
5010
  /**
5011
+ * @public
4569
5012
  * <p>An optional limit for the number of resources returned in a single call. </p>
4570
5013
  * <p>Default value: <code>100</code>
4571
5014
  * </p>
4572
5015
  */
4573
5016
  MaxResults?: number;
4574
5017
  /**
5018
+ * @public
4575
5019
  * <p>The pagination token specifying which page of results to return in the response. If no
4576
5020
  * token is provided, the default page is the first page. </p>
4577
5021
  * <p>Default value: <code>null</code>
@@ -4585,31 +5029,37 @@ export interface ListTrackersRequest {
4585
5029
  */
4586
5030
  export interface ListTrackersResponseEntry {
4587
5031
  /**
5032
+ * @public
4588
5033
  * <p>The name of the tracker resource.</p>
4589
5034
  */
4590
5035
  TrackerName: string | undefined;
4591
5036
  /**
5037
+ * @public
4592
5038
  * <p>The description for the tracker resource.</p>
4593
5039
  */
4594
5040
  Description: string | undefined;
4595
5041
  /**
5042
+ * @public
4596
5043
  * @deprecated
4597
5044
  *
4598
5045
  * <p>Always returns <code>RequestBasedUsage</code>.</p>
4599
5046
  */
4600
5047
  PricingPlan?: PricingPlan | string;
4601
5048
  /**
5049
+ * @public
4602
5050
  * @deprecated
4603
5051
  *
4604
5052
  * <p>No longer used. Always returns an empty string.</p>
4605
5053
  */
4606
5054
  PricingPlanDataSource?: string;
4607
5055
  /**
5056
+ * @public
4608
5057
  * <p>The timestamp for when the tracker resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
4609
5058
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4610
5059
  */
4611
5060
  CreateTime: Date | undefined;
4612
5061
  /**
5062
+ * @public
4613
5063
  * <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
4614
5064
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4615
5065
  */
@@ -4620,11 +5070,13 @@ export interface ListTrackersResponseEntry {
4620
5070
  */
4621
5071
  export interface ListTrackersResponse {
4622
5072
  /**
5073
+ * @public
4623
5074
  * <p>Contains tracker resources in your Amazon Web Services account. Details include tracker name,
4624
5075
  * description and timestamps for when the tracker was created and last updated.</p>
4625
5076
  */
4626
5077
  Entries: ListTrackersResponseEntry[] | undefined;
4627
5078
  /**
5079
+ * @public
4628
5080
  * <p>A pagination token indicating there are additional pages available. You can use the
4629
5081
  * token in a following request to fetch the next set of results. </p>
4630
5082
  */
@@ -4636,6 +5088,7 @@ export interface ListTrackersResponse {
4636
5088
  */
4637
5089
  export interface MapConfigurationUpdate {
4638
5090
  /**
5091
+ * @public
4639
5092
  * <p>Specifies the political view for the style. Set to an empty string to not use a
4640
5093
  * political view, or, for styles that support specific political views, you can choose a
4641
5094
  * view, such as <code>IND</code> for the Indian view.</p>
@@ -4653,10 +5106,12 @@ export interface MapConfigurationUpdate {
4653
5106
  */
4654
5107
  export interface UpdateMapRequest {
4655
5108
  /**
5109
+ * @public
4656
5110
  * <p>The name of the map resource to update.</p>
4657
5111
  */
4658
5112
  MapName: string | undefined;
4659
5113
  /**
5114
+ * @public
4660
5115
  * @deprecated
4661
5116
  *
4662
5117
  * <p>No longer used. If included, the only allowed value is
@@ -4664,10 +5119,12 @@ export interface UpdateMapRequest {
4664
5119
  */
4665
5120
  PricingPlan?: PricingPlan | string;
4666
5121
  /**
5122
+ * @public
4667
5123
  * <p>Updates the description for the map resource.</p>
4668
5124
  */
4669
5125
  Description?: string;
4670
5126
  /**
5127
+ * @public
4671
5128
  * <p>Updates the parts of the map configuration that can be updated, including the
4672
5129
  * political view.</p>
4673
5130
  */
@@ -4678,10 +5135,12 @@ export interface UpdateMapRequest {
4678
5135
  */
4679
5136
  export interface UpdateMapResponse {
4680
5137
  /**
5138
+ * @public
4681
5139
  * <p>The name of the updated map resource.</p>
4682
5140
  */
4683
5141
  MapName: string | undefined;
4684
5142
  /**
5143
+ * @public
4685
5144
  * <p>The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource
4686
5145
  * across AWS.</p>
4687
5146
  * <ul>
@@ -4693,6 +5152,7 @@ export interface UpdateMapResponse {
4693
5152
  */
4694
5153
  MapArn: string | undefined;
4695
5154
  /**
5155
+ * @public
4696
5156
  * <p>The timestamp for when the map resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
4697
5157
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4698
5158
  */
@@ -4703,10 +5163,12 @@ export interface UpdateMapResponse {
4703
5163
  */
4704
5164
  export interface SearchPlaceIndexForPositionRequest {
4705
5165
  /**
5166
+ * @public
4706
5167
  * <p>The name of the place index resource you want to use for the search.</p>
4707
5168
  */
4708
5169
  IndexName: string | undefined;
4709
5170
  /**
5171
+ * @public
4710
5172
  * <p>Specifies the longitude and latitude of the position to query.</p>
4711
5173
  * <p> This parameter must contain a pair of numbers. The first number represents the X
4712
5174
  * coordinate, or longitude; the second number represents the Y coordinate, or
@@ -4716,12 +5178,14 @@ export interface SearchPlaceIndexForPositionRequest {
4716
5178
  */
4717
5179
  Position: number[] | undefined;
4718
5180
  /**
5181
+ * @public
4719
5182
  * <p>An optional parameter. The maximum number of results returned per request.</p>
4720
5183
  * <p>Default value: <code>50</code>
4721
5184
  * </p>
4722
5185
  */
4723
5186
  MaxResults?: number;
4724
5187
  /**
5188
+ * @public
4725
5189
  * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
4726
5190
  * <code>en</code> for English.</p>
4727
5191
  * <p>This setting affects the languages used in the results, but not the results
@@ -4739,6 +5203,7 @@ export interface SearchPlaceIndexForPositionRequest {
4739
5203
  */
4740
5204
  Language?: string;
4741
5205
  /**
5206
+ * @public
4742
5207
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
4743
5208
  * the request.</p>
4744
5209
  */
@@ -4751,10 +5216,12 @@ export interface SearchPlaceIndexForPositionRequest {
4751
5216
  */
4752
5217
  export interface SearchForPositionResult {
4753
5218
  /**
5219
+ * @public
4754
5220
  * <p>Details about the search result, such as its address and position.</p>
4755
5221
  */
4756
5222
  Place: Place | undefined;
4757
5223
  /**
5224
+ * @public
4758
5225
  * <p>The distance in meters of a great-circle arc between the query position and the
4759
5226
  * result.</p>
4760
5227
  * <note>
@@ -4764,6 +5231,7 @@ export interface SearchForPositionResult {
4764
5231
  */
4765
5232
  Distance: number | undefined;
4766
5233
  /**
5234
+ * @public
4767
5235
  * <p>The unique identifier of the place. You can use this with the <code>GetPlace</code>
4768
5236
  * operation to find the place again later.</p>
4769
5237
  * <note>
@@ -4780,16 +5248,19 @@ export interface SearchForPositionResult {
4780
5248
  */
4781
5249
  export interface SearchPlaceIndexForPositionSummary {
4782
5250
  /**
5251
+ * @public
4783
5252
  * <p>The position specified in the request.</p>
4784
5253
  */
4785
5254
  Position: number[] | undefined;
4786
5255
  /**
5256
+ * @public
4787
5257
  * <p>Contains the optional result count limit that is specified in the request.</p>
4788
5258
  * <p>Default value: <code>50</code>
4789
5259
  * </p>
4790
5260
  */
4791
5261
  MaxResults?: number;
4792
5262
  /**
5263
+ * @public
4793
5264
  * <p>The geospatial data provider attached to the place index resource specified in the
4794
5265
  * request. Values can be one of the following:</p>
4795
5266
  * <ul>
@@ -4807,6 +5278,7 @@ export interface SearchPlaceIndexForPositionSummary {
4807
5278
  */
4808
5279
  DataSource: string | undefined;
4809
5280
  /**
5281
+ * @public
4810
5282
  * <p>The preferred language used to return results. Matches the language in the request.
4811
5283
  * The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a>
4812
5284
  * language tag, for example, <code>en</code> for English.</p>
@@ -4818,12 +5290,14 @@ export interface SearchPlaceIndexForPositionSummary {
4818
5290
  */
4819
5291
  export interface SearchPlaceIndexForPositionResponse {
4820
5292
  /**
5293
+ * @public
4821
5294
  * <p>Contains a summary of the request. Echoes the input values for <code>Position</code>,
4822
5295
  * <code>Language</code>, <code>MaxResults</code>, and the <code>DataSource</code> of
4823
5296
  * the place index. </p>
4824
5297
  */
4825
5298
  Summary: SearchPlaceIndexForPositionSummary | undefined;
4826
5299
  /**
5300
+ * @public
4827
5301
  * <p>Returns a list of Places closest to the specified position. Each result contains
4828
5302
  * additional information about the Places returned.</p>
4829
5303
  */
@@ -4834,15 +5308,18 @@ export interface SearchPlaceIndexForPositionResponse {
4834
5308
  */
4835
5309
  export interface SearchPlaceIndexForSuggestionsRequest {
4836
5310
  /**
5311
+ * @public
4837
5312
  * <p>The name of the place index resource you want to use for the search.</p>
4838
5313
  */
4839
5314
  IndexName: string | undefined;
4840
5315
  /**
5316
+ * @public
4841
5317
  * <p>The free-form partial text to use to generate place suggestions. For example,
4842
5318
  * <code>eiffel tow</code>.</p>
4843
5319
  */
4844
5320
  Text: string | undefined;
4845
5321
  /**
5322
+ * @public
4846
5323
  * <p>An optional parameter that indicates a preference for place suggestions that are
4847
5324
  * closer to a specified position.</p>
4848
5325
  * <p> If provided, this parameter must contain a pair of numbers. The first number
@@ -4858,6 +5335,7 @@ export interface SearchPlaceIndexForSuggestionsRequest {
4858
5335
  */
4859
5336
  BiasPosition?: number[];
4860
5337
  /**
5338
+ * @public
4861
5339
  * <p>An optional parameter that limits the search results by returning only suggestions
4862
5340
  * within a specified bounding box.</p>
4863
5341
  * <p> If provided, this parameter must contain a total of four consecutive numbers in two
@@ -4877,6 +5355,7 @@ export interface SearchPlaceIndexForSuggestionsRequest {
4877
5355
  */
4878
5356
  FilterBBox?: number[];
4879
5357
  /**
5358
+ * @public
4880
5359
  * <p>An optional parameter that limits the search results by returning only suggestions
4881
5360
  * within the provided list of countries.</p>
4882
5361
  * <ul>
@@ -4889,12 +5368,14 @@ export interface SearchPlaceIndexForSuggestionsRequest {
4889
5368
  */
4890
5369
  FilterCountries?: string[];
4891
5370
  /**
5371
+ * @public
4892
5372
  * <p>An optional parameter. The maximum number of results returned per request. </p>
4893
5373
  * <p>The default: <code>5</code>
4894
5374
  * </p>
4895
5375
  */
4896
5376
  MaxResults?: number;
4897
5377
  /**
5378
+ * @public
4898
5379
  * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
4899
5380
  * <code>en</code> for English.</p>
4900
5381
  * <p>This setting affects the languages used in the results. If no language is specified,
@@ -4910,6 +5391,7 @@ export interface SearchPlaceIndexForSuggestionsRequest {
4910
5391
  */
4911
5392
  Language?: string;
4912
5393
  /**
5394
+ * @public
4913
5395
  * <p>A list of one or more Amazon Location categories to filter the returned places. If you
4914
5396
  * include more than one category, the results will include results that match
4915
5397
  * <i>any</i> of the categories listed.</p>
@@ -4919,6 +5401,7 @@ export interface SearchPlaceIndexForSuggestionsRequest {
4919
5401
  */
4920
5402
  FilterCategories?: string[];
4921
5403
  /**
5404
+ * @public
4922
5405
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
4923
5406
  * the request.</p>
4924
5407
  */
@@ -4931,10 +5414,12 @@ export interface SearchPlaceIndexForSuggestionsRequest {
4931
5414
  */
4932
5415
  export interface SearchForSuggestionsResult {
4933
5416
  /**
5417
+ * @public
4934
5418
  * <p>The text of the place suggestion, typically formatted as an address string.</p>
4935
5419
  */
4936
5420
  Text: string | undefined;
4937
5421
  /**
5422
+ * @public
4938
5423
  * <p>The unique identifier of the Place. You can use this with the <code>GetPlace</code>
4939
5424
  * operation to find the place again later, or to get full information for the Place.</p>
4940
5425
  * <p>The <code>GetPlace</code> request must use the same <code>PlaceIndex</code>
@@ -4948,6 +5433,7 @@ export interface SearchForSuggestionsResult {
4948
5433
  */
4949
5434
  PlaceId?: string;
4950
5435
  /**
5436
+ * @public
4951
5437
  * <p>The Amazon Location categories that describe the Place.</p>
4952
5438
  * <p>For more information about using categories, including a list of Amazon Location
4953
5439
  * categories, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html">Categories and filtering</a>, in the <i>Amazon Location Service Developer
@@ -4955,6 +5441,7 @@ export interface SearchForSuggestionsResult {
4955
5441
  */
4956
5442
  Categories?: string[];
4957
5443
  /**
5444
+ * @public
4958
5445
  * <p>Categories from the data provider that describe the Place that are not mapped
4959
5446
  * to any Amazon Location categories.</p>
4960
5447
  */
@@ -4967,10 +5454,12 @@ export interface SearchForSuggestionsResult {
4967
5454
  */
4968
5455
  export interface SearchPlaceIndexForSuggestionsSummary {
4969
5456
  /**
5457
+ * @public
4970
5458
  * <p>The free-form partial text input specified in the request.</p>
4971
5459
  */
4972
5460
  Text: string | undefined;
4973
5461
  /**
5462
+ * @public
4974
5463
  * <p>Contains the coordinates for the optional bias position specified in the
4975
5464
  * request.</p>
4976
5465
  * <p>This parameter contains a pair of numbers. The first number represents the X
@@ -4981,19 +5470,23 @@ export interface SearchPlaceIndexForSuggestionsSummary {
4981
5470
  */
4982
5471
  BiasPosition?: number[];
4983
5472
  /**
5473
+ * @public
4984
5474
  * <p>Contains the coordinates for the optional bounding box specified in the
4985
5475
  * request.</p>
4986
5476
  */
4987
5477
  FilterBBox?: number[];
4988
5478
  /**
5479
+ * @public
4989
5480
  * <p>Contains the optional country filter specified in the request.</p>
4990
5481
  */
4991
5482
  FilterCountries?: string[];
4992
5483
  /**
5484
+ * @public
4993
5485
  * <p>Contains the optional result count limit specified in the request.</p>
4994
5486
  */
4995
5487
  MaxResults?: number;
4996
5488
  /**
5489
+ * @public
4997
5490
  * <p>The geospatial data provider attached to the place index resource specified in the
4998
5491
  * request. Values can be one of the following:</p>
4999
5492
  * <ul>
@@ -5011,12 +5504,14 @@ export interface SearchPlaceIndexForSuggestionsSummary {
5011
5504
  */
5012
5505
  DataSource: string | undefined;
5013
5506
  /**
5507
+ * @public
5014
5508
  * <p>The preferred language used to return results. Matches the language in the request.
5015
5509
  * The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a>
5016
5510
  * language tag, for example, <code>en</code> for English.</p>
5017
5511
  */
5018
5512
  Language?: string;
5019
5513
  /**
5514
+ * @public
5020
5515
  * <p>The optional category filter specified in the request.</p>
5021
5516
  */
5022
5517
  FilterCategories?: string[];
@@ -5026,6 +5521,7 @@ export interface SearchPlaceIndexForSuggestionsSummary {
5026
5521
  */
5027
5522
  export interface SearchPlaceIndexForSuggestionsResponse {
5028
5523
  /**
5524
+ * @public
5029
5525
  * <p>Contains a summary of the request. Echoes the input values for
5030
5526
  * <code>BiasPosition</code>, <code>FilterBBox</code>, <code>FilterCountries</code>,
5031
5527
  * <code>Language</code>, <code>MaxResults</code>, and <code>Text</code>. Also includes
@@ -5033,6 +5529,7 @@ export interface SearchPlaceIndexForSuggestionsResponse {
5033
5529
  */
5034
5530
  Summary: SearchPlaceIndexForSuggestionsSummary | undefined;
5035
5531
  /**
5532
+ * @public
5036
5533
  * <p>A list of place suggestions that best match the search text.</p>
5037
5534
  */
5038
5535
  Results: SearchForSuggestionsResult[] | undefined;
@@ -5042,15 +5539,18 @@ export interface SearchPlaceIndexForSuggestionsResponse {
5042
5539
  */
5043
5540
  export interface SearchPlaceIndexForTextRequest {
5044
5541
  /**
5542
+ * @public
5045
5543
  * <p>The name of the place index resource you want to use for the search.</p>
5046
5544
  */
5047
5545
  IndexName: string | undefined;
5048
5546
  /**
5547
+ * @public
5049
5548
  * <p>The address, name, city, or region to be used in the search in free-form text format.
5050
5549
  * For example, <code>123 Any Street</code>.</p>
5051
5550
  */
5052
5551
  Text: string | undefined;
5053
5552
  /**
5553
+ * @public
5054
5554
  * <p>An optional parameter that indicates a preference for places that are closer to a
5055
5555
  * specified position.</p>
5056
5556
  * <p> If provided, this parameter must contain a pair of numbers. The first number
@@ -5066,6 +5566,7 @@ export interface SearchPlaceIndexForTextRequest {
5066
5566
  */
5067
5567
  BiasPosition?: number[];
5068
5568
  /**
5569
+ * @public
5069
5570
  * <p>An optional parameter that limits the search results by returning only places that are
5070
5571
  * within the provided bounding box.</p>
5071
5572
  * <p> If provided, this parameter must contain a total of four consecutive numbers in two
@@ -5085,6 +5586,7 @@ export interface SearchPlaceIndexForTextRequest {
5085
5586
  */
5086
5587
  FilterBBox?: number[];
5087
5588
  /**
5589
+ * @public
5088
5590
  * <p>An optional parameter that limits the search results by returning only places that are
5089
5591
  * in a specified list of countries.</p>
5090
5592
  * <ul>
@@ -5097,12 +5599,14 @@ export interface SearchPlaceIndexForTextRequest {
5097
5599
  */
5098
5600
  FilterCountries?: string[];
5099
5601
  /**
5602
+ * @public
5100
5603
  * <p>An optional parameter. The maximum number of results returned per request. </p>
5101
5604
  * <p>The default: <code>50</code>
5102
5605
  * </p>
5103
5606
  */
5104
5607
  MaxResults?: number;
5105
5608
  /**
5609
+ * @public
5106
5610
  * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
5107
5611
  * <code>en</code> for English.</p>
5108
5612
  * <p>This setting affects the languages used in the results, but not the results
@@ -5118,6 +5622,7 @@ export interface SearchPlaceIndexForTextRequest {
5118
5622
  */
5119
5623
  Language?: string;
5120
5624
  /**
5625
+ * @public
5121
5626
  * <p>A list of one or more Amazon Location categories to filter the returned places. If you
5122
5627
  * include more than one category, the results will include results that match
5123
5628
  * <i>any</i> of the categories listed.</p>
@@ -5127,6 +5632,7 @@ export interface SearchPlaceIndexForTextRequest {
5127
5632
  */
5128
5633
  FilterCategories?: string[];
5129
5634
  /**
5635
+ * @public
5130
5636
  * <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
5131
5637
  * the request.</p>
5132
5638
  */
@@ -5139,10 +5645,12 @@ export interface SearchPlaceIndexForTextRequest {
5139
5645
  */
5140
5646
  export interface SearchForTextResult {
5141
5647
  /**
5648
+ * @public
5142
5649
  * <p>Details about the search result, such as its address and position.</p>
5143
5650
  */
5144
5651
  Place: Place | undefined;
5145
5652
  /**
5653
+ * @public
5146
5654
  * <p>The distance in meters of a great-circle arc between the bias position specified and
5147
5655
  * the result. <code>Distance</code> will be returned only if a bias position was specified
5148
5656
  * in the query.</p>
@@ -5153,6 +5661,7 @@ export interface SearchForTextResult {
5153
5661
  */
5154
5662
  Distance?: number;
5155
5663
  /**
5664
+ * @public
5156
5665
  * <p>The relative confidence in the match for a result among the results returned. For
5157
5666
  * example, if more fields for an address match (including house number, street, city,
5158
5667
  * country/region, and postal code), the relevance score is closer to 1.</p>
@@ -5160,6 +5669,7 @@ export interface SearchForTextResult {
5160
5669
  */
5161
5670
  Relevance?: number;
5162
5671
  /**
5672
+ * @public
5163
5673
  * <p>The unique identifier of the place. You can use this with the <code>GetPlace</code>
5164
5674
  * operation to find the place again later.</p>
5165
5675
  * <note>
@@ -5175,10 +5685,12 @@ export interface SearchForTextResult {
5175
5685
  */
5176
5686
  export interface SearchPlaceIndexForTextSummary {
5177
5687
  /**
5688
+ * @public
5178
5689
  * <p>The search text specified in the request.</p>
5179
5690
  */
5180
5691
  Text: string | undefined;
5181
5692
  /**
5693
+ * @public
5182
5694
  * <p>Contains the coordinates for the optional bias position specified in the
5183
5695
  * request.</p>
5184
5696
  * <p>This parameter contains a pair of numbers. The first number represents the X
@@ -5189,19 +5701,23 @@ export interface SearchPlaceIndexForTextSummary {
5189
5701
  */
5190
5702
  BiasPosition?: number[];
5191
5703
  /**
5704
+ * @public
5192
5705
  * <p>Contains the coordinates for the optional bounding box specified in the
5193
5706
  * request.</p>
5194
5707
  */
5195
5708
  FilterBBox?: number[];
5196
5709
  /**
5710
+ * @public
5197
5711
  * <p>Contains the optional country filter specified in the request.</p>
5198
5712
  */
5199
5713
  FilterCountries?: string[];
5200
5714
  /**
5715
+ * @public
5201
5716
  * <p>Contains the optional result count limit specified in the request.</p>
5202
5717
  */
5203
5718
  MaxResults?: number;
5204
5719
  /**
5720
+ * @public
5205
5721
  * <p>The bounding box that fully contains all search results.</p>
5206
5722
  * <note>
5207
5723
  * <p>If you specified the optional <code>FilterBBox</code> parameter in the request,
@@ -5210,6 +5726,7 @@ export interface SearchPlaceIndexForTextSummary {
5210
5726
  */
5211
5727
  ResultBBox?: number[];
5212
5728
  /**
5729
+ * @public
5213
5730
  * <p>The geospatial data provider attached to the place index resource specified in the
5214
5731
  * request. Values can be one of the following:</p>
5215
5732
  * <ul>
@@ -5227,12 +5744,14 @@ export interface SearchPlaceIndexForTextSummary {
5227
5744
  */
5228
5745
  DataSource: string | undefined;
5229
5746
  /**
5747
+ * @public
5230
5748
  * <p>The preferred language used to return results. Matches the language in the request.
5231
5749
  * The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a>
5232
5750
  * language tag, for example, <code>en</code> for English.</p>
5233
5751
  */
5234
5752
  Language?: string;
5235
5753
  /**
5754
+ * @public
5236
5755
  * <p>The optional category filter specified in the request.</p>
5237
5756
  */
5238
5757
  FilterCategories?: string[];
@@ -5242,6 +5761,7 @@ export interface SearchPlaceIndexForTextSummary {
5242
5761
  */
5243
5762
  export interface SearchPlaceIndexForTextResponse {
5244
5763
  /**
5764
+ * @public
5245
5765
  * <p>Contains a summary of the request. Echoes the input values for
5246
5766
  * <code>BiasPosition</code>, <code>FilterBBox</code>, <code>FilterCountries</code>,
5247
5767
  * <code>Language</code>, <code>MaxResults</code>, and <code>Text</code>. Also includes
@@ -5250,6 +5770,7 @@ export interface SearchPlaceIndexForTextResponse {
5250
5770
  */
5251
5771
  Summary: SearchPlaceIndexForTextSummary | undefined;
5252
5772
  /**
5773
+ * @public
5253
5774
  * <p>A list of Places matching the input text. Each result contains additional information
5254
5775
  * about the specific point of interest. </p>
5255
5776
  * <p>Not all response properties are included with all responses. Some properties may only
@@ -5262,10 +5783,12 @@ export interface SearchPlaceIndexForTextResponse {
5262
5783
  */
5263
5784
  export interface UpdatePlaceIndexRequest {
5264
5785
  /**
5786
+ * @public
5265
5787
  * <p>The name of the place index resource to update.</p>
5266
5788
  */
5267
5789
  IndexName: string | undefined;
5268
5790
  /**
5791
+ * @public
5269
5792
  * @deprecated
5270
5793
  *
5271
5794
  * <p>No longer used. If included, the only allowed value is
@@ -5273,10 +5796,12 @@ export interface UpdatePlaceIndexRequest {
5273
5796
  */
5274
5797
  PricingPlan?: PricingPlan | string;
5275
5798
  /**
5799
+ * @public
5276
5800
  * <p>Updates the description for the place index resource.</p>
5277
5801
  */
5278
5802
  Description?: string;
5279
5803
  /**
5804
+ * @public
5280
5805
  * <p>Updates the data storage option for the place index resource.</p>
5281
5806
  */
5282
5807
  DataSourceConfiguration?: DataSourceConfiguration;
@@ -5286,10 +5811,12 @@ export interface UpdatePlaceIndexRequest {
5286
5811
  */
5287
5812
  export interface UpdatePlaceIndexResponse {
5288
5813
  /**
5814
+ * @public
5289
5815
  * <p>The name of the updated place index resource.</p>
5290
5816
  */
5291
5817
  IndexName: string | undefined;
5292
5818
  /**
5819
+ * @public
5293
5820
  * <p>The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a
5294
5821
  * resource across Amazon Web Services.</p>
5295
5822
  * <ul>
@@ -5302,6 +5829,7 @@ export interface UpdatePlaceIndexResponse {
5302
5829
  */
5303
5830
  IndexArn: string | undefined;
5304
5831
  /**
5832
+ * @public
5305
5833
  * <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
5306
5834
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
5307
5835
  */
@@ -5312,10 +5840,12 @@ export interface UpdatePlaceIndexResponse {
5312
5840
  */
5313
5841
  export interface UpdateRouteCalculatorRequest {
5314
5842
  /**
5843
+ * @public
5315
5844
  * <p>The name of the route calculator resource to update.</p>
5316
5845
  */
5317
5846
  CalculatorName: string | undefined;
5318
5847
  /**
5848
+ * @public
5319
5849
  * @deprecated
5320
5850
  *
5321
5851
  * <p>No longer used. If included, the only allowed value is
@@ -5323,6 +5853,7 @@ export interface UpdateRouteCalculatorRequest {
5323
5853
  */
5324
5854
  PricingPlan?: PricingPlan | string;
5325
5855
  /**
5856
+ * @public
5326
5857
  * <p>Updates the description for the route calculator resource.</p>
5327
5858
  */
5328
5859
  Description?: string;
@@ -5332,10 +5863,12 @@ export interface UpdateRouteCalculatorRequest {
5332
5863
  */
5333
5864
  export interface UpdateRouteCalculatorResponse {
5334
5865
  /**
5866
+ * @public
5335
5867
  * <p>The name of the updated route calculator resource.</p>
5336
5868
  */
5337
5869
  CalculatorName: string | undefined;
5338
5870
  /**
5871
+ * @public
5339
5872
  * <p>The Amazon Resource Name (ARN) of the updated route calculator resource. Used to
5340
5873
  * specify a resource across AWS.</p>
5341
5874
  * <ul>
@@ -5348,6 +5881,7 @@ export interface UpdateRouteCalculatorResponse {
5348
5881
  */
5349
5882
  CalculatorArn: string | undefined;
5350
5883
  /**
5884
+ * @public
5351
5885
  * <p>The timestamp for when the route calculator was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
5352
5886
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
5353
5887
  */
@@ -5358,10 +5892,12 @@ export interface UpdateRouteCalculatorResponse {
5358
5892
  */
5359
5893
  export interface UpdateTrackerRequest {
5360
5894
  /**
5895
+ * @public
5361
5896
  * <p>The name of the tracker resource to update.</p>
5362
5897
  */
5363
5898
  TrackerName: string | undefined;
5364
5899
  /**
5900
+ * @public
5365
5901
  * @deprecated
5366
5902
  *
5367
5903
  * <p>No longer used. If included, the only allowed value is
@@ -5369,16 +5905,19 @@ export interface UpdateTrackerRequest {
5369
5905
  */
5370
5906
  PricingPlan?: PricingPlan | string;
5371
5907
  /**
5908
+ * @public
5372
5909
  * @deprecated
5373
5910
  *
5374
5911
  * <p>This parameter is no longer used.</p>
5375
5912
  */
5376
5913
  PricingPlanDataSource?: string;
5377
5914
  /**
5915
+ * @public
5378
5916
  * <p>Updates the description for the tracker resource.</p>
5379
5917
  */
5380
5918
  Description?: string;
5381
5919
  /**
5920
+ * @public
5382
5921
  * <p>Updates the position filtering for the tracker resource.</p>
5383
5922
  * <p>Valid values:</p>
5384
5923
  * <ul>
@@ -5412,6 +5951,7 @@ export interface UpdateTrackerRequest {
5412
5951
  */
5413
5952
  PositionFiltering?: PositionFiltering | string;
5414
5953
  /**
5954
+ * @public
5415
5955
  * <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to
5416
5956
  * EventBridge.</p>
5417
5957
  * <note>
@@ -5427,10 +5967,12 @@ export interface UpdateTrackerRequest {
5427
5967
  */
5428
5968
  export interface UpdateTrackerResponse {
5429
5969
  /**
5970
+ * @public
5430
5971
  * <p>The name of the updated tracker resource.</p>
5431
5972
  */
5432
5973
  TrackerName: string | undefined;
5433
5974
  /**
5975
+ * @public
5434
5976
  * <p>The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across
5435
5977
  * AWS.</p>
5436
5978
  * <ul>
@@ -5442,6 +5984,7 @@ export interface UpdateTrackerResponse {
5442
5984
  */
5443
5985
  TrackerArn: string | undefined;
5444
5986
  /**
5987
+ * @public
5445
5988
  * <p>The timestamp for when the tracker resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
5446
5989
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
5447
5990
  */