-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
docs-2.json
1904 lines (1904 loc) · 160 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p>\"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing\"</p>",
"operations": {
"AssociateTrackerConsumer": "<p>Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. </p> <p>You can associate up to five geofence collections to each tracker resource.</p> <note> <p>Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.</p> </note>",
"BatchDeleteDevicePositionHistory": "<p>Deletes the position history of one or more devices from a tracker resource.</p>",
"BatchDeleteGeofence": "<p>Deletes a batch of geofences from a geofence collection.</p> <note> <p>This operation deletes the resource permanently.</p> </note>",
"BatchEvaluateGeofences": "<p>Evaluates device positions against the geofence geometries from a given geofence collection.</p> <p>This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:</p> <ul> <li> <p> <code>ENTER</code> if Amazon Location determines that the tracked device has entered a geofenced area.</p> </li> <li> <p> <code>EXIT</code> if Amazon Location determines that the tracked device has exited a geofenced area.</p> </li> </ul> <note> <p>The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.</p> </note> <note> <p>Geofence evaluation uses the given device position. It does not account for the optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p> </note> <note> <p>The <code>DeviceID</code> is used as a string to represent the device. You do not need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p> </note>",
"BatchGetDevicePosition": "<p>Lists the latest device positions for requested devices.</p>",
"BatchPutGeofence": "<p>A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.</p>",
"BatchUpdateDevicePosition": "<p>Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.</p> <note> <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker. When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p> <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).</p> <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location uses the default value <code>{ \"Horizontal\": 0}</code> when accuracy is not provided on a <code>DevicePositionUpdate</code>.</p> </note>",
"CalculateRoute": "<p> <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html\">Calculates a route</a> given the following required parameters: <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that you first <a href=\"https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html\">create a route calculator resource</a>.</p> <p>By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.</p> <p>Additional options include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html\">Specifying a departure time</a> using either <code>DepartureTime</code> or <code>DepartNow</code>. This calculates a route based on predictive traffic data at the given time. </p> <note> <p>You can't specify both <code>DepartureTime</code> and <code>DepartNow</code> in a single request. Specifying both parameters returns a validation error.</p> </note> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html\">Specifying a travel mode</a> using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p> <note> <p>If you specify <code>walking</code> for the travel mode and your data provider is Esri, the start and destination must be within 40km.</p> </note> </li> </ul>",
"CalculateRouteMatrix": "<p> <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html\"> Calculates a route matrix</a> given the following required parameters: <code>DeparturePositions</code> and <code>DestinationPositions</code>. <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, <code>CalculateRouteMatrix</code> will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of <code>DeparturePositions</code> times the number of <code>DestinationPositions</code>.</p> <note> <p>Your account is charged for each route calculated, not the number of requests.</p> </note> <p>Requires that you first <a href=\"https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html\">create a route calculator resource</a>.</p> <p>By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.</p> <p>Additional options include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html\"> Specifying a departure time</a> using either <code>DepartureTime</code> or <code>DepartNow</code>. This calculates routes based on predictive traffic data at the given time. </p> <note> <p>You can't specify both <code>DepartureTime</code> and <code>DepartNow</code> in a single request. Specifying both parameters returns a validation error.</p> </note> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html\">Specifying a travel mode</a> using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>, or <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p> </li> </ul>",
"CreateGeofenceCollection": "<p>Creates a geofence collection, which manages and stores geofences.</p>",
"CreateMap": "<p>Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.</p> <note> <p>If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the <a href=\"http://aws.amazon.com/service-terms\">AWS service terms</a> for more details.</p> </note>",
"CreatePlaceIndex": "<p>Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p> <note> <p>If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the <a href=\"http://aws.amazon.com/service-terms\">AWS service terms</a> for more details.</p> </note>",
"CreateRouteCalculator": "<p>Creates a route calculator resource in your AWS account.</p> <p>You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.</p> <note> <p>If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the <a href=\"http://aws.amazon.com/service-terms\">AWS service terms</a> for more details.</p> </note>",
"CreateTracker": "<p>Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.</p>",
"DeleteGeofenceCollection": "<p>Deletes a geofence collection from your AWS account.</p> <note> <p>This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.</p> </note>",
"DeleteMap": "<p>Deletes a map resource from your AWS account.</p> <note> <p>This operation deletes the resource permanently. If the map is being used in an application, the map may not render.</p> </note>",
"DeletePlaceIndex": "<p>Deletes a place index resource from your AWS account.</p> <note> <p>This operation deletes the resource permanently.</p> </note>",
"DeleteRouteCalculator": "<p>Deletes a route calculator resource from your AWS account.</p> <note> <p>This operation deletes the resource permanently.</p> </note>",
"DeleteTracker": "<p>Deletes a tracker resource from your AWS account.</p> <note> <p>This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.</p> </note>",
"DescribeGeofenceCollection": "<p>Retrieves the geofence collection details.</p>",
"DescribeMap": "<p>Retrieves the map resource details.</p>",
"DescribePlaceIndex": "<p>Retrieves the place index resource details.</p>",
"DescribeRouteCalculator": "<p>Retrieves the route calculator resource details.</p>",
"DescribeTracker": "<p>Retrieves the tracker resource details.</p>",
"DisassociateTrackerConsumer": "<p>Removes the association between a tracker resource and a geofence collection.</p> <note> <p>Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.</p> </note>",
"GetDevicePosition": "<p>Retrieves a device's most recent position according to its sample time.</p> <note> <p>Device positions are deleted after 30 days.</p> </note>",
"GetDevicePositionHistory": "<p>Retrieves the device position history from a tracker resource within a specified range of time.</p> <note> <p>Device positions are deleted after 30 days.</p> </note>",
"GetGeofence": "<p>Retrieves the geofence details from a geofence collection.</p>",
"GetMapGlyphs": "<p>Retrieves glyphs used to display labels on a map.</p>",
"GetMapSprites": "<p>Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.</p>",
"GetMapStyleDescriptor": "<p>Retrieves the map style descriptor from a map resource. </p> <p>The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.</p>",
"GetMapTile": "<p>Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. </p> <p>The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).</p>",
"ListDevicePositions": "<p>A batch request to retrieve all device positions.</p>",
"ListGeofenceCollections": "<p>Lists geofence collections in your AWS account.</p>",
"ListGeofences": "<p>Lists geofences stored in a given geofence collection.</p>",
"ListMaps": "<p>Lists map resources in your AWS account.</p>",
"ListPlaceIndexes": "<p>Lists place index resources in your AWS account.</p>",
"ListRouteCalculators": "<p>Lists route calculator resources in your AWS account.</p>",
"ListTagsForResource": "<p>Returns a list of tags that are applied to the specified Amazon Location resource.</p>",
"ListTrackerConsumers": "<p>Lists geofence collections currently associated to the given tracker resource.</p>",
"ListTrackers": "<p>Lists tracker resources in your AWS account.</p>",
"PutGeofence": "<p>Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request. </p>",
"SearchPlaceIndexForPosition": "<p>Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.</p>",
"SearchPlaceIndexForSuggestions": "<p>Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.</p> <p>Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.</p> <note> <p>You can search for suggested place names near a specified position by using <code>BiasPosition</code>, or filter results within a bounding box by using <code>FilterBBox</code>. These parameters are mutually exclusive; using both <code>BiasPosition</code> and <code>FilterBBox</code> in the same command returns an error.</p> </note>",
"SearchPlaceIndexForText": "<p>Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest. </p> <p>Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.</p> <note> <p>You can search for places near a given position using <code>BiasPosition</code>, or filter results within a bounding box using <code>FilterBBox</code>. Providing both parameters simultaneously returns an error.</p> </note> <p>Search results are returned in order of highest to lowest relevance.</p>",
"TagResource": "<p>Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.</p> <pre><code> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p> </code></pre>",
"UntagResource": "<p>Removes one or more tags from the specified Amazon Location resource.</p>",
"UpdateGeofenceCollection": "<p>Updates the specified properties of a given geofence collection.</p>",
"UpdateMap": "<p>Updates the specified properties of a given map resource.</p>",
"UpdatePlaceIndex": "<p>Updates the specified properties of a given place index resource.</p>",
"UpdateRouteCalculator": "<p>Updates the specified properties for a given route calculator resource.</p>",
"UpdateTracker": "<p>Updates the specified properties of a given tracker resource.</p>"
},
"shapes": {
"AccessDeniedException": {
"base": "<p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>",
"refs": {
}
},
"Arn": {
"base": null,
"refs": {
"ArnList$member": null,
"AssociateTrackerConsumerRequest$ConsumerArn": "<p>The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer</code> </p> </li> </ul>",
"CreateGeofenceCollectionResponse$CollectionArn": "<p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code> </p> </li> </ul>",
"CreateMapResponse$MapArn": "<p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:maps/ExampleMap</code> </p> </li> </ul>",
"CreatePlaceIndexResponse$IndexArn": "<p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code> </p> </li> </ul>",
"CreateRouteCalculatorResponse$CalculatorArn": "<p>The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:route-calculator/ExampleCalculator</code> </p> </li> </ul>",
"CreateTrackerResponse$TrackerArn": "<p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code> </p> </li> </ul>",
"DescribeGeofenceCollectionResponse$CollectionArn": "<p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code> </p> </li> </ul>",
"DescribeMapResponse$MapArn": "<p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:maps/ExampleMap</code> </p> </li> </ul>",
"DescribePlaceIndexResponse$IndexArn": "<p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code> </p> </li> </ul>",
"DescribeRouteCalculatorResponse$CalculatorArn": "<p>The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:route-calculator/ExampleCalculator</code> </p> </li> </ul>",
"DescribeTrackerResponse$TrackerArn": "<p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code> </p> </li> </ul>",
"DisassociateTrackerConsumerRequest$ConsumerArn": "<p>The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer</code> </p> </li> </ul>",
"ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code> </p> </li> </ul>",
"TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource whose tags you want to update.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code> </p> </li> </ul>",
"UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource from which you want to remove tags.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code> </p> </li> </ul>",
"UpdateGeofenceCollectionResponse$CollectionArn": "<p>The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code> </p> </li> </ul>",
"UpdateMapResponse$MapArn": "<p>The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:maps/ExampleMap</code> </p> </li> </ul>",
"UpdatePlaceIndexResponse$IndexArn": "<p>The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex</code> </p> </li> </ul>",
"UpdateRouteCalculatorResponse$CalculatorArn": "<p>The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:route- calculator/ExampleCalculator</code> </p> </li> </ul>",
"UpdateTrackerResponse$TrackerArn": "<p>The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code> </p> </li> </ul>"
}
},
"ArnList": {
"base": null,
"refs": {
"ListTrackerConsumersResponse$ConsumerArns": "<p>Contains the list of geofence collection ARNs associated to the tracker resource.</p>"
}
},
"AssociateTrackerConsumerRequest": {
"base": null,
"refs": {
}
},
"AssociateTrackerConsumerResponse": {
"base": null,
"refs": {
}
},
"BatchDeleteDevicePositionHistoryError": {
"base": "<p>Contains the tracker resource details.</p>",
"refs": {
"BatchDeleteDevicePositionHistoryErrorList$member": null
}
},
"BatchDeleteDevicePositionHistoryErrorList": {
"base": null,
"refs": {
"BatchDeleteDevicePositionHistoryResponse$Errors": "<p>Contains error details for each device history that failed to delete.</p>"
}
},
"BatchDeleteDevicePositionHistoryRequest": {
"base": null,
"refs": {
}
},
"BatchDeleteDevicePositionHistoryRequestDeviceIdsList": {
"base": null,
"refs": {
"BatchDeleteDevicePositionHistoryRequest$DeviceIds": "<p>Devices whose position history you want to delete.</p> <ul> <li> <p>For example, for two devices: <code>“DeviceIds” : [DeviceId1,DeviceId2]</code> </p> </li> </ul>"
}
},
"BatchDeleteDevicePositionHistoryResponse": {
"base": null,
"refs": {
}
},
"BatchDeleteGeofenceError": {
"base": "<p>Contains error details for each geofence that failed to delete from the geofence collection.</p>",
"refs": {
"BatchDeleteGeofenceErrorList$member": null
}
},
"BatchDeleteGeofenceErrorList": {
"base": null,
"refs": {
"BatchDeleteGeofenceResponse$Errors": "<p>Contains error details for each geofence that failed to delete.</p>"
}
},
"BatchDeleteGeofenceRequest": {
"base": null,
"refs": {
}
},
"BatchDeleteGeofenceRequestGeofenceIdsList": {
"base": null,
"refs": {
"BatchDeleteGeofenceRequest$GeofenceIds": "<p>The batch of geofences to be deleted.</p>"
}
},
"BatchDeleteGeofenceResponse": {
"base": null,
"refs": {
}
},
"BatchEvaluateGeofencesError": {
"base": "<p>Contains error details for each device that failed to evaluate its position against the geofences in a given geofence collection.</p>",
"refs": {
"BatchEvaluateGeofencesErrorList$member": null
}
},
"BatchEvaluateGeofencesErrorList": {
"base": null,
"refs": {
"BatchEvaluateGeofencesResponse$Errors": "<p>Contains error details for each device that failed to evaluate its position against the given geofence collection.</p>"
}
},
"BatchEvaluateGeofencesRequest": {
"base": null,
"refs": {
}
},
"BatchEvaluateGeofencesRequestDevicePositionUpdatesList": {
"base": null,
"refs": {
"BatchEvaluateGeofencesRequest$DevicePositionUpdates": "<p>Contains device details for each device to be evaluated against the given geofence collection.</p>"
}
},
"BatchEvaluateGeofencesResponse": {
"base": null,
"refs": {
}
},
"BatchGetDevicePositionError": {
"base": "<p>Contains error details for each device that didn't return a position.</p>",
"refs": {
"BatchGetDevicePositionErrorList$member": null
}
},
"BatchGetDevicePositionErrorList": {
"base": null,
"refs": {
"BatchGetDevicePositionResponse$Errors": "<p>Contains error details for each device that failed to send its position to the tracker resource.</p>"
}
},
"BatchGetDevicePositionRequest": {
"base": null,
"refs": {
}
},
"BatchGetDevicePositionRequestDeviceIdsList": {
"base": null,
"refs": {
"BatchGetDevicePositionRequest$DeviceIds": "<p>Devices whose position you want to retrieve.</p> <ul> <li> <p>For example, for two devices: <code>device-ids=DeviceId1&device-ids=DeviceId2</code> </p> </li> </ul>"
}
},
"BatchGetDevicePositionRequestTrackerNameString": {
"base": null,
"refs": {
"BatchGetDevicePositionRequest$TrackerName": "<p>The tracker resource retrieving the device position.</p>"
}
},
"BatchGetDevicePositionResponse": {
"base": null,
"refs": {
}
},
"BatchItemError": {
"base": "<p>Contains the batch request error details associated with the request.</p>",
"refs": {
"BatchDeleteDevicePositionHistoryError$Error": null,
"BatchDeleteGeofenceError$Error": "<p>Contains details associated to the batch error.</p>",
"BatchEvaluateGeofencesError$Error": "<p>Contains details associated to the batch error.</p>",
"BatchGetDevicePositionError$Error": "<p>Contains details related to the error code.</p>",
"BatchPutGeofenceError$Error": "<p>Contains details associated to the batch error.</p>",
"BatchUpdateDevicePositionError$Error": "<p>Contains details related to the error code such as the error code and error message.</p>"
}
},
"BatchItemErrorCode": {
"base": null,
"refs": {
"BatchItemError$Code": "<p>The error code associated with the batch request error.</p>"
}
},
"BatchPutGeofenceError": {
"base": "<p>Contains error details for each geofence that failed to be stored in a given geofence collection.</p>",
"refs": {
"BatchPutGeofenceErrorList$member": null
}
},
"BatchPutGeofenceErrorList": {
"base": null,
"refs": {
"BatchPutGeofenceResponse$Errors": "<p>Contains additional error details for each geofence that failed to be stored in a geofence collection.</p>"
}
},
"BatchPutGeofenceRequest": {
"base": null,
"refs": {
}
},
"BatchPutGeofenceRequestEntriesList": {
"base": null,
"refs": {
"BatchPutGeofenceRequest$Entries": "<p>The batch of geofences to be stored in a geofence collection.</p>"
}
},
"BatchPutGeofenceRequestEntry": {
"base": "<p>Contains geofence geometry details. </p>",
"refs": {
"BatchPutGeofenceRequestEntriesList$member": null
}
},
"BatchPutGeofenceResponse": {
"base": null,
"refs": {
}
},
"BatchPutGeofenceSuccess": {
"base": "<p>Contains a summary of each geofence that was successfully stored in a given geofence collection.</p>",
"refs": {
"BatchPutGeofenceSuccessList$member": null
}
},
"BatchPutGeofenceSuccessList": {
"base": null,
"refs": {
"BatchPutGeofenceResponse$Successes": "<p>Contains each geofence that was successfully stored in a geofence collection.</p>"
}
},
"BatchUpdateDevicePositionError": {
"base": "<p>Contains error details for each device that failed to update its position.</p>",
"refs": {
"BatchUpdateDevicePositionErrorList$member": null
}
},
"BatchUpdateDevicePositionErrorList": {
"base": null,
"refs": {
"BatchUpdateDevicePositionResponse$Errors": "<p>Contains error details for each device that failed to update its position.</p>"
}
},
"BatchUpdateDevicePositionRequest": {
"base": null,
"refs": {
}
},
"BatchUpdateDevicePositionRequestUpdatesList": {
"base": null,
"refs": {
"BatchUpdateDevicePositionRequest$Updates": "<p>Contains the position update details for each device.</p>"
}
},
"BatchUpdateDevicePositionResponse": {
"base": null,
"refs": {
}
},
"Blob": {
"base": null,
"refs": {
"GetMapGlyphsResponse$Blob": "<p>The blob's content type.</p>",
"GetMapSpritesResponse$Blob": "<p>Contains the body of the sprite sheet or JSON offset file.</p>",
"GetMapStyleDescriptorResponse$Blob": "<p>Contains the body of the style descriptor.</p>",
"GetMapTileResponse$Blob": "<p>Contains Mapbox Vector Tile (MVT) data.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"CalculateRouteCarModeOptions$AvoidFerries": "<p>Avoids ferries when calculating routes.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>",
"CalculateRouteCarModeOptions$AvoidTolls": "<p>Avoids tolls when calculating routes.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>",
"CalculateRouteMatrixRequest$DepartNow": "<p>Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>",
"CalculateRouteRequest$DepartNow": "<p>Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>",
"CalculateRouteRequest$IncludeLegGeometry": "<p>Set to include the geometry details in the result for each path between a pair of positions.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>",
"CalculateRouteTruckModeOptions$AvoidFerries": "<p>Avoids ferries when calculating routes.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>",
"CalculateRouteTruckModeOptions$AvoidTolls": "<p>Avoids tolls when calculating routes.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>",
"Place$Interpolated": "<p> <code>True</code> if the result is interpolated from other known places.</p> <p> <code>False</code> if the Place is a known place.</p> <p>Not returned when the partner does not provide the information.</p> <p>For example, returns <code>False</code> for an address location that is found in the partner data, but returns <code>True</code> if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses. </p>"
}
},
"BoundingBox": {
"base": null,
"refs": {
"CalculateRouteSummary$RouteBBox": "<p>Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, <code>[min x, min y, max x, max y]</code>.</p> <p>The first 2 <code>bbox</code> parameters describe the lower southwest corner: </p> <ul> <li> <p>The first <code>bbox</code> position is the X coordinate or longitude of the lower southwest corner. </p> </li> <li> <p>The second <code>bbox</code> position is the Y coordinate or latitude of the lower southwest corner. </p> </li> </ul> <p>The next 2 <code>bbox</code> parameters describe the upper northeast corner: </p> <ul> <li> <p>The third <code>bbox</code> position is the X coordinate, or longitude of the upper northeast corner. </p> </li> <li> <p>The fourth <code>bbox</code> position is the Y coordinate, or latitude of the upper northeast corner. </p> </li> </ul>",
"SearchPlaceIndexForSuggestionsRequest$FilterBBox": "<p>An optional parameter that limits the search results by returning only suggestions within a specified bounding box.</p> <p> If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.</p> <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p> <note> <p> <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error. </p> </note>",
"SearchPlaceIndexForSuggestionsSummary$FilterBBox": "<p>Contains the coordinates for the optional bounding box specified in the request.</p>",
"SearchPlaceIndexForTextRequest$FilterBBox": "<p>An optional parameter that limits the search results by returning only places that are within the provided bounding box.</p> <p> If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.</p> <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p> <note> <p> <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error. </p> </note>",
"SearchPlaceIndexForTextSummary$FilterBBox": "<p>Contains the coordinates for the optional bounding box specified in the request.</p>",
"SearchPlaceIndexForTextSummary$ResultBBox": "<p>The bounding box that fully contains all search results.</p> <note> <p>If you specified the optional <code>FilterBBox</code> parameter in the request, <code>ResultBBox</code> is contained within <code>FilterBBox</code>.</p> </note>"
}
},
"CalculateRouteCarModeOptions": {
"base": "<p>Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Car</code>.</p>",
"refs": {
"CalculateRouteMatrixRequest$CarModeOptions": "<p>Specifies route preferences when traveling by <code>Car</code>, such as avoiding routes that use ferries or tolls.</p> <p>Requirements: <code>TravelMode</code> must be specified as <code>Car</code>.</p>",
"CalculateRouteRequest$CarModeOptions": "<p>Specifies route preferences when traveling by <code>Car</code>, such as avoiding routes that use ferries or tolls.</p> <p>Requirements: <code>TravelMode</code> must be specified as <code>Car</code>.</p>"
}
},
"CalculateRouteMatrixRequest": {
"base": null,
"refs": {
}
},
"CalculateRouteMatrixRequestDeparturePositionsList": {
"base": null,
"refs": {
"CalculateRouteMatrixRequest$DeparturePositions": "<p>The list of departure (origin) positions for the route matrix. An array of points, 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: <code>[longitude, latitude]</code>. For example, <code>[-123.115, 49.285]</code>.</p> <important> <p>Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits\"> Position restrictions</a> in the <i>Amazon Location Service Developer Guide</i>.</p> </important> <note> <p>For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html\"> moves the position to the nearest road</a>. The snapped value is available in the result in <code>SnappedDeparturePositions</code>.</p> </note> <p>Valid Values: <code>[-180 to 180,-90 to 90]</code> </p>"
}
},
"CalculateRouteMatrixRequestDestinationPositionsList": {
"base": null,
"refs": {
"CalculateRouteMatrixRequest$DestinationPositions": "<p>The list of destination positions for the route matrix. An array of points, 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: <code>[longitude, latitude]</code>. For example, <code>[-122.339, 47.615]</code> </p> <important> <p>Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits\"> Position restrictions</a> in the <i>Amazon Location Service Developer Guide</i>.</p> </important> <note> <p>For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html\"> moves the position to the nearest road</a>. The snapped value is available in the result in <code>SnappedDestinationPositions</code>.</p> </note> <p>Valid Values: <code>[-180 to 180,-90 to 90]</code> </p>"
}
},
"CalculateRouteMatrixResponse": {
"base": "<p>Returns the result of the route matrix calculation.</p>",
"refs": {
}
},
"CalculateRouteMatrixResponseSnappedDeparturePositionsList": {
"base": null,
"refs": {
"CalculateRouteMatrixResponse$SnappedDeparturePositions": "<p>For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the <code>RouteMatrix</code>.</p>"
}
},
"CalculateRouteMatrixResponseSnappedDestinationPositionsList": {
"base": null,
"refs": {
"CalculateRouteMatrixResponse$SnappedDestinationPositions": "<p>The list of destination positions for the route matrix used for calculation of the <code>RouteMatrix</code>.</p>"
}
},
"CalculateRouteMatrixSummary": {
"base": "<p>A summary of the calculated route matrix.</p>",
"refs": {
"CalculateRouteMatrixResponse$Summary": "<p>Contains information about the route matrix, <code>DataSource</code>, <code>DistanceUnit</code>, <code>RouteCount</code> and <code>ErrorCount</code>.</p>"
}
},
"CalculateRouteMatrixSummaryErrorCountInteger": {
"base": null,
"refs": {
"CalculateRouteMatrixSummary$ErrorCount": "<p>The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.</p>"
}
},
"CalculateRouteMatrixSummaryRouteCountInteger": {
"base": null,
"refs": {
"CalculateRouteMatrixSummary$RouteCount": "<p>The count of cells in the route matrix. Equal to the number of <code>DeparturePositions</code> multiplied by the number of <code>DestinationPositions</code>.</p>"
}
},
"CalculateRouteRequest": {
"base": null,
"refs": {
}
},
"CalculateRouteRequestWaypointPositionsList": {
"base": null,
"refs": {
"CalculateRouteRequest$WaypointPositions": "<p>Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. </p> <ul> <li> <p>For example, from the <code>DeparturePosition</code> <code>[-123.115, 49.285]</code>, the route follows the order that the waypoint positions are given <code>[[-122.757, 49.0021],[-122.349, 47.620]]</code> </p> </li> </ul> <note> <p>If you specify a waypoint position that's not located on a road, Amazon Location <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html\">moves the position to the nearest road</a>. </p> <p>Specifying more than 23 waypoints returns a <code>400 ValidationException</code> error.</p> <p>If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error.</p> </note> <p>Valid Values: <code>[-180 to 180,-90 to 90]</code> </p>"
}
},
"CalculateRouteResponse": {
"base": "<p>Returns the result of the route calculation. Metadata includes legs and route summary.</p>",
"refs": {
}
},
"CalculateRouteSummary": {
"base": "<p>A summary of the calculated route.</p>",
"refs": {
"CalculateRouteResponse$Summary": "<p>Contains information about the whole route, such as: <code>RouteBBox</code>, <code>DataSource</code>, <code>Distance</code>, <code>DistanceUnit</code>, and <code>DurationSeconds</code>.</p>"
}
},
"CalculateRouteSummaryDistanceDouble": {
"base": null,
"refs": {
"CalculateRouteSummary$Distance": "<p>The total distance covered by the route. The sum of the distance travelled between every stop on the route.</p> <note> <p>If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a <code>400 RoutesValidationException</code> error.</p> </note>"
}
},
"CalculateRouteSummaryDurationSecondsDouble": {
"base": null,
"refs": {
"CalculateRouteSummary$DurationSeconds": "<p>The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.</p>"
}
},
"CalculateRouteTruckModeOptions": {
"base": "<p>Contains details about additional route preferences for requests that specify <code>TravelMode</code> as <code>Truck</code>.</p>",
"refs": {
"CalculateRouteMatrixRequest$TruckModeOptions": "<p>Specifies route preferences when traveling by <code>Truck</code>, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.</p> <p>Requirements: <code>TravelMode</code> must be specified as <code>Truck</code>.</p>",
"CalculateRouteRequest$TruckModeOptions": "<p>Specifies route preferences when traveling by <code>Truck</code>, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.</p> <p>Requirements: <code>TravelMode</code> must be specified as <code>Truck</code>.</p>"
}
},
"Circle": {
"base": "<p>A circle on the earth, as defined by a center point and a radius.</p>",
"refs": {
"GeofenceGeometry$Circle": "<p>A circle on the earth, as defined by a center point and a radius.</p>"
}
},
"ConflictException": {
"base": "<p>The request was unsuccessful because of a conflict.</p>",
"refs": {
}
},
"CountryCode": {
"base": null,
"refs": {
"CountryCodeList$member": null
}
},
"CountryCodeList": {
"base": null,
"refs": {
"SearchPlaceIndexForSuggestionsRequest$FilterCountries": "<p>An optional parameter that limits the search results by returning only suggestions within the provided list of countries.</p> <ul> <li> <p>Use the <a href=\"https://www.iso.org/iso-3166-country-codes.html\">ISO 3166</a> 3-digit country code. For example, Australia uses three upper-case characters: <code>AUS</code>.</p> </li> </ul>",
"SearchPlaceIndexForSuggestionsSummary$FilterCountries": "<p>Contains the optional country filter specified in the request.</p>",
"SearchPlaceIndexForTextRequest$FilterCountries": "<p>An optional parameter that limits the search results by returning only places that are in a specified list of countries.</p> <ul> <li> <p>Valid values include <a href=\"https://www.iso.org/iso-3166-country-codes.html\">ISO 3166</a> 3-digit country codes. For example, Australia uses three upper-case characters: <code>AUS</code>.</p> </li> </ul>",
"SearchPlaceIndexForTextSummary$FilterCountries": "<p>Contains the optional country filter specified in the request.</p>"
}
},
"CreateGeofenceCollectionRequest": {
"base": null,
"refs": {
}
},
"CreateGeofenceCollectionResponse": {
"base": null,
"refs": {
}
},
"CreateMapRequest": {
"base": null,
"refs": {
}
},
"CreateMapResponse": {
"base": null,
"refs": {
}
},
"CreatePlaceIndexRequest": {
"base": null,
"refs": {
}
},
"CreatePlaceIndexResponse": {
"base": null,
"refs": {
}
},
"CreateRouteCalculatorRequest": {
"base": null,
"refs": {
}
},
"CreateRouteCalculatorResponse": {
"base": null,
"refs": {
}
},
"CreateTrackerRequest": {
"base": null,
"refs": {
}
},
"CreateTrackerResponse": {
"base": null,
"refs": {
}
},
"DataSourceConfiguration": {
"base": "<p>Specifies the data storage option chosen for requesting Places.</p> <important> <p>When using Amazon Location Places:</p> <ul> <li> <p>If using HERE Technologies as a data provider, you can't store results for locations in Japan by setting <code>IntendedUse</code> to <code>Storage</code>. parameter.</p> </li> <li> <p>Under the <code>MobileAssetTracking</code> or <code>MobilAssetManagement</code> pricing plan, you can't store results from your place index resources by setting <code>IntendedUse</code> to <code>Storage</code>. This returns a validation exception error.</p> </li> </ul> <p>For more information, see the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> for Amazon Location Service.</p> </important>",
"refs": {
"CreatePlaceIndexRequest$DataSourceConfiguration": "<p>Specifies the data storage option requesting Places.</p>",
"DescribePlaceIndexResponse$DataSourceConfiguration": "<p>The specified data storage option for requesting Places.</p>",
"UpdatePlaceIndexRequest$DataSourceConfiguration": "<p>Updates the data storage option for the place index resource.</p>"
}
},
"DeleteGeofenceCollectionRequest": {
"base": null,
"refs": {
}
},
"DeleteGeofenceCollectionResponse": {
"base": null,
"refs": {
}
},
"DeleteMapRequest": {
"base": null,
"refs": {
}
},
"DeleteMapResponse": {
"base": null,
"refs": {
}
},
"DeletePlaceIndexRequest": {
"base": null,
"refs": {
}
},
"DeletePlaceIndexResponse": {
"base": null,
"refs": {
}
},
"DeleteRouteCalculatorRequest": {
"base": null,
"refs": {
}
},
"DeleteRouteCalculatorResponse": {
"base": null,
"refs": {
}
},
"DeleteTrackerRequest": {
"base": null,
"refs": {
}
},
"DeleteTrackerResponse": {
"base": null,
"refs": {
}
},
"DescribeGeofenceCollectionRequest": {
"base": null,
"refs": {
}
},
"DescribeGeofenceCollectionResponse": {
"base": null,
"refs": {
}
},
"DescribeMapRequest": {
"base": null,
"refs": {
}
},
"DescribeMapResponse": {
"base": null,
"refs": {
}
},
"DescribePlaceIndexRequest": {
"base": null,
"refs": {
}
},
"DescribePlaceIndexResponse": {
"base": null,
"refs": {
}
},
"DescribeRouteCalculatorRequest": {
"base": null,
"refs": {
}
},
"DescribeRouteCalculatorResponse": {
"base": null,
"refs": {
}
},
"DescribeTrackerRequest": {
"base": null,
"refs": {
}
},
"DescribeTrackerResponse": {
"base": null,
"refs": {
}
},
"DevicePosition": {
"base": "<p>Contains the device position details.</p>",
"refs": {
"DevicePositionList$member": null
}
},
"DevicePositionList": {
"base": null,
"refs": {
"BatchGetDevicePositionResponse$DevicePositions": "<p>Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.</p>",
"GetDevicePositionHistoryResponse$DevicePositions": "<p>Contains the position history details for the requested device.</p>"
}
},
"DevicePositionUpdate": {
"base": "<p>Contains the position update details for a device.</p>",
"refs": {
"BatchEvaluateGeofencesRequestDevicePositionUpdatesList$member": null,
"BatchUpdateDevicePositionRequestUpdatesList$member": null
}
},
"DimensionUnit": {
"base": null,
"refs": {
"TruckDimensions$Unit": "<p> Specifies the unit of measurement for the truck dimensions.</p> <p>Default Value: <code>Meters</code> </p>"
}
},
"DisassociateTrackerConsumerRequest": {
"base": null,
"refs": {
}
},
"DisassociateTrackerConsumerResponse": {
"base": null,
"refs": {
}
},
"DistanceUnit": {
"base": null,
"refs": {
"CalculateRouteMatrixRequest$DistanceUnit": "<p>Set the unit system to specify the distance.</p> <p>Default Value: <code>Kilometers</code> </p>",
"CalculateRouteMatrixSummary$DistanceUnit": "<p>The unit of measurement for route distances.</p>",
"CalculateRouteRequest$DistanceUnit": "<p>Set the unit system to specify the distance.</p> <p>Default Value: <code>Kilometers</code> </p>",
"CalculateRouteSummary$DistanceUnit": "<p>The unit of measurement for route distances.</p>"
}
},
"Double": {
"base": null,
"refs": {
"BoundingBox$member": null,
"Circle$Radius": "<p>The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).</p>",
"Position$member": null
}
},
"GeofenceGeometry": {
"base": "<p>Contains the geofence geometry details.</p> <p>A geofence geometry is made up of either a polygon or a circle. Can be either a polygon or a circle. Including both will return a validation error.</p> <note> <p>Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian. </p> </note>",
"refs": {
"BatchPutGeofenceRequestEntry$Geometry": "<p>Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.</p> <note> <p>Each <a href=\"https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html\"> geofence polygon</a> can have a maximum of 1,000 vertices.</p> </note>",
"GetGeofenceResponse$Geometry": "<p>Contains the geofence geometry details describing a polygon or a circle.</p>",
"ListGeofenceResponseEntry$Geometry": "<p>Contains the geofence geometry details describing a polygon or a circle.</p>",
"PutGeofenceRequest$Geometry": "<p>Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.</p> <note> <p>Each <a href=\"https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html\"> geofence polygon</a> can have a maximum of 1,000 vertices.</p> </note>"
}
},
"GetDevicePositionHistoryRequest": {
"base": null,
"refs": {
}
},
"GetDevicePositionHistoryRequestMaxResultsInteger": {
"base": null,
"refs": {
"GetDevicePositionHistoryRequest$MaxResults": "<p>An optional limit for the number of device positions returned in a single call.</p> <p>Default value: <code>100</code> </p>"
}
},
"GetDevicePositionHistoryResponse": {
"base": null,
"refs": {
}
},
"GetDevicePositionRequest": {
"base": null,
"refs": {
}
},
"GetDevicePositionResponse": {
"base": null,
"refs": {
}
},
"GetGeofenceRequest": {
"base": null,
"refs": {
}
},
"GetGeofenceResponse": {
"base": null,
"refs": {
}
},
"GetMapGlyphsRequest": {
"base": null,
"refs": {
}
},
"GetMapGlyphsRequestFontUnicodeRangeString": {
"base": null,
"refs": {
"GetMapGlyphsRequest$FontUnicodeRange": "<p>A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range <code>U+0000</code> to <code>00FF</code>. Must be aligned to multiples of 256.</p>"
}
},
"GetMapGlyphsResponse": {
"base": null,
"refs": {
}
},
"GetMapSpritesRequest": {
"base": null,
"refs": {
}
},
"GetMapSpritesRequestFileNameString": {
"base": null,
"refs": {
"GetMapSpritesRequest$FileName": "<p>The name of the sprite file. Use the following file names for the sprite sheet:</p> <ul> <li> <p> <code>sprites.png</code> </p> </li> <li> <p> <code>sprites@2x.png</code> for high pixel density displays</p> </li> </ul> <p>For the JSON document contain image offsets. Use the following file names:</p> <ul> <li> <p> <code>sprites.json</code> </p> </li> <li> <p> <code>sprites@2x.json</code> for high pixel density displays</p> </li> </ul>"
}
},
"GetMapSpritesResponse": {
"base": null,
"refs": {
}
},
"GetMapStyleDescriptorRequest": {
"base": null,
"refs": {
}
},
"GetMapStyleDescriptorResponse": {
"base": null,
"refs": {
}
},
"GetMapTileRequest": {
"base": null,
"refs": {
}
},
"GetMapTileRequestXString": {
"base": null,
"refs": {
"GetMapTileRequest$X": "<p>The X axis value for the map tile.</p>"
}
},
"GetMapTileRequestYString": {
"base": null,
"refs": {
"GetMapTileRequest$Y": "<p>The Y axis value for the map tile. </p>"
}
},
"GetMapTileRequestZString": {
"base": null,
"refs": {
"GetMapTileRequest$Z": "<p>The zoom value for the map tile.</p>"
}
},
"GetMapTileResponse": {
"base": null,
"refs": {
}
},
"Id": {
"base": null,
"refs": {
"BatchDeleteDevicePositionHistoryError$DeviceId": "<p>The ID of the device for this position.</p>",
"BatchDeleteDevicePositionHistoryRequestDeviceIdsList$member": null,
"BatchDeleteGeofenceError$GeofenceId": "<p>The geofence associated with the error message.</p>",
"BatchDeleteGeofenceRequestGeofenceIdsList$member": null,
"BatchEvaluateGeofencesError$DeviceId": "<p>The device associated with the position evaluation error.</p>",
"BatchGetDevicePositionError$DeviceId": "<p>The ID of the device that didn't return a position.</p>",
"BatchGetDevicePositionRequestDeviceIdsList$member": null,
"BatchPutGeofenceError$GeofenceId": "<p>The geofence associated with the error message.</p>",
"BatchPutGeofenceRequestEntry$GeofenceId": "<p>The identifier for the geofence to be stored in a given geofence collection.</p>",
"BatchPutGeofenceSuccess$GeofenceId": "<p>The geofence successfully stored in a geofence collection.</p>",
"BatchUpdateDevicePositionError$DeviceId": "<p>The device associated with the failed location update.</p>",
"DevicePosition$DeviceId": "<p>The device whose position you retrieved.</p>",
"DevicePositionUpdate$DeviceId": "<p>The device associated to the position update.</p>",
"GetDevicePositionHistoryRequest$DeviceId": "<p>The device whose position history you want to retrieve.</p>",
"GetDevicePositionRequest$DeviceId": "<p>The device whose position you want to retrieve.</p>",
"GetDevicePositionResponse$DeviceId": "<p>The device whose position you retrieved.</p>",
"GetGeofenceRequest$GeofenceId": "<p>The geofence you're retrieving details for.</p>",
"GetGeofenceResponse$GeofenceId": "<p>The geofence identifier.</p>",
"ListDevicePositionsResponseEntry$DeviceId": "<p>The ID of the device for this position.</p>",
"ListGeofenceResponseEntry$GeofenceId": "<p>The geofence identifier.</p>",
"PutGeofenceRequest$GeofenceId": "<p>An identifier for the geofence. For example, <code>ExampleGeofence-1</code>.</p>",
"PutGeofenceResponse$GeofenceId": "<p>The geofence identifier entered in the request.</p>"
}
},
"Integer": {
"base": null,
"refs": {
"SearchPlaceIndexForSuggestionsSummary$MaxResults": "<p>Contains the optional result count limit specified in the request.</p>",
"TimeZone$Offset": "<p>The time zone's offset, in seconds, from UTC.</p>"
}
},
"IntendedUse": {
"base": null,
"refs": {
"DataSourceConfiguration$IntendedUse": "<p>Specifies how the results of an operation will be stored by the caller. </p> <p>Valid values include:</p> <ul> <li> <p> <code>SingleUse</code> specifies that the results won't be stored. </p> </li> <li> <p> <code>Storage</code> specifies that the result can be cached or stored in a database.</p> </li> </ul> <p>Default value: <code>SingleUse</code> </p>"
}
},
"InternalServerException": {
"base": "<p>The request has failed to process because of an unknown server error, exception, or failure.</p>",
"refs": {
}
},
"KmsKeyId": {
"base": null,
"refs": {
"CreateGeofenceCollectionRequest$KmsKeyId": "<p>A key identifier for an <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html\">AWS KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN. </p>",
"CreateTrackerRequest$KmsKeyId": "<p>A key identifier for an <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html\">AWS KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>",
"DescribeGeofenceCollectionResponse$KmsKeyId": "<p>A key identifier for an <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html\">AWS KMS customer managed key</a> assigned to the Amazon Location resource</p>",
"DescribeTrackerResponse$KmsKeyId": "<p>A key identifier for an <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html\">AWS KMS customer managed key</a> assigned to the Amazon Location resource.</p>"
}
},
"LanguageTag": {
"base": null,
"refs": {
"SearchPlaceIndexForPositionRequest$Language": "<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, <code>en</code> for English.</p> <p>This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.</p> <p>For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the <code>language</code> parameter set to <code>en</code>. The <code>city</code> in the results will most likely be returned as <code>Athens</code>.</p> <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the <code>city</code> in the results will more likely be returned as <code>Αθήνα</code>.</p> <p>If the data provider does not have a value for Greek, the result will be in a language that the provider does support.</p>",
"SearchPlaceIndexForPositionSummary$Language": "<p>The preferred language used to return results. Matches the language in the request. The value is a valid <a href=\"https://tools.ietf.org/search/bcp47\">BCP 47</a> language tag, for example, <code>en</code> for English.</p>",
"SearchPlaceIndexForSuggestionsRequest$Language": "<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, <code>en</code> for English.</p> <p>This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.</p> <p>For an example, we'll use the Greek language. You search for <code>Athens, Gr</code> to get suggestions with the <code>language</code> parameter set to <code>en</code>. The results found will most likely be returned as <code>Athens, Greece</code>.</p> <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the result found will more likely be returned as <code>Αθήνα, Ελλάδα</code>.</p> <p>If the data provider does not have a value for Greek, the result will be in a language that the provider does support.</p>",
"SearchPlaceIndexForSuggestionsSummary$Language": "<p>The preferred language used to return results. Matches the language in the request. The value is a valid <a href=\"https://tools.ietf.org/search/bcp47\">BCP 47</a> language tag, for example, <code>en</code> for English.</p>",
"SearchPlaceIndexForTextRequest$Language": "<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, <code>en</code> for English.</p> <p>This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.</p> <p>For an example, we'll use the Greek language. You search for <code>Athens, Greece</code>, with the <code>language</code> parameter set to <code>en</code>. The result found will most likely be returned as <code>Athens</code>.</p> <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the result found will more likely be returned as <code>Αθήνα</code>.</p> <p>If the data provider does not have a value for Greek, the result will be in a language that the provider does support.</p>",
"SearchPlaceIndexForTextSummary$Language": "<p>The preferred language used to return results. Matches the language in the request. The value is a valid <a href=\"https://tools.ietf.org/search/bcp47\">BCP 47</a> language tag, for example, <code>en</code> for English.</p>"
}
},
"Leg": {
"base": "<p>Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request. </p> <p>For example, a route with a departure position and destination position returns one leg with the positions <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html\">snapped to a nearby road</a>:</p> <ul> <li> <p>The <code>StartPosition</code> is the departure position.</p> </li> <li> <p>The <code>EndPosition</code> is the destination position.</p> </li> </ul> <p>A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:</p> <ul> <li> <p>Leg 1: The <code>StartPosition</code> is the departure position . The <code>EndPosition</code> is the waypoint positon.</p> </li> <li> <p>Leg 2: The <code>StartPosition</code> is the waypoint position. The <code>EndPosition</code> is the destination position.</p> </li> </ul>",
"refs": {
"LegList$member": null
}
},
"LegDistanceDouble": {
"base": null,
"refs": {
"Leg$Distance": "<p>The distance between the leg's <code>StartPosition</code> and <code>EndPosition</code> along a calculated route. </p> <ul> <li> <p>The default measurement is <code>Kilometers</code> unless the request specifies a <code>DistanceUnit</code> of <code>Miles</code>.</p> </li> </ul>"
}
},
"LegDurationSecondsDouble": {
"base": null,
"refs": {
"Leg$DurationSeconds": "<p>The estimated travel time between the leg's <code>StartPosition</code> and <code>EndPosition</code>. The travel mode and departure time that you specify in the request determines the calculated time.</p>"
}
},
"LegGeometry": {
"base": "<p>Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.</p>",
"refs": {
"Leg$Geometry": "<p>Contains the calculated route's path as a linestring geometry.</p>"
}
},
"LegList": {
"base": null,
"refs": {
"CalculateRouteResponse$Legs": "<p>Contains details about each path between a pair of positions included along a route such as: <code>StartPosition</code>, <code>EndPosition</code>, <code>Distance</code>, <code>DurationSeconds</code>, <code>Geometry</code>, and <code>Steps</code>. The number of legs returned corresponds to one fewer than the total number of positions in the request. </p> <p>For example, a route with a departure position and destination position returns one leg with the positions <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html\">snapped to a nearby road</a>:</p> <ul> <li> <p>The <code>StartPosition</code> is the departure position.</p> </li> <li> <p>The <code>EndPosition</code> is the destination position.</p> </li> </ul> <p>A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:</p> <ul> <li> <p>Leg 1: The <code>StartPosition</code> is the departure position . The <code>EndPosition</code> is the waypoint positon.</p> </li> <li> <p>Leg 2: The <code>StartPosition</code> is the waypoint position. The <code>EndPosition</code> is the destination position.</p> </li> </ul>"
}
},
"LineString": {
"base": null,
"refs": {
"LegGeometry$LineString": "<p>An ordered list of positions used to plot a route on a map. </p> <p>The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.</p> <ul> <li> <p>For example, <code>[[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]</code> </p> </li> </ul>"
}
},
"LinearRing": {
"base": null,
"refs": {
"LinearRings$member": null
}
},
"LinearRings": {
"base": null,
"refs": {
"GeofenceGeometry$Polygon": "<p>An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: <code>[longitude, latitude]</code>. </p> <p>The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.</p> <p>A geofence polygon can consist of between 4 and 1,000 vertices.</p>"
}
},
"ListDevicePositionsRequest": {
"base": null,
"refs": {
}
},
"ListDevicePositionsRequestMaxResultsInteger": {
"base": null,
"refs": {
"ListDevicePositionsRequest$MaxResults": "<p>An optional limit for the number of entries returned in a single call.</p> <p>Default value: <code>100</code> </p>"
}
},
"ListDevicePositionsResponse": {
"base": null,
"refs": {
}
},
"ListDevicePositionsResponseEntry": {
"base": "<p>Contains the tracker resource details.</p>",
"refs": {
"ListDevicePositionsResponseEntryList$member": null
}
},
"ListDevicePositionsResponseEntryList": {
"base": null,
"refs": {
"ListDevicePositionsResponse$Entries": "<p>Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.</p>"
}
},
"ListGeofenceCollectionsRequest": {
"base": null,
"refs": {
}
},
"ListGeofenceCollectionsRequestMaxResultsInteger": {
"base": null,
"refs": {
"ListGeofenceCollectionsRequest$MaxResults": "<p>An optional limit for the number of resources returned in a single call. </p> <p>Default value: <code>100</code> </p>"
}
},
"ListGeofenceCollectionsResponse": {
"base": null,
"refs": {
}
},
"ListGeofenceCollectionsResponseEntry": {
"base": "<p>Contains the geofence collection details.</p>",
"refs": {
"ListGeofenceCollectionsResponseEntryList$member": null
}
},
"ListGeofenceCollectionsResponseEntryList": {
"base": null,
"refs": {
"ListGeofenceCollectionsResponse$Entries": "<p>Lists the geofence collections that exist in your AWS account.</p>"
}
},
"ListGeofenceResponseEntry": {
"base": "<p>Contains a list of geofences stored in a given geofence collection.</p>",
"refs": {
"ListGeofenceResponseEntryList$member": null
}
},
"ListGeofenceResponseEntryList": {
"base": null,
"refs": {
"ListGeofencesResponse$Entries": "<p>Contains a list of geofences stored in the geofence collection.</p>"
}
},
"ListGeofencesRequest": {
"base": null,
"refs": {
}
},
"ListGeofencesRequestMaxResultsInteger": {
"base": null,
"refs": {
"ListGeofencesRequest$MaxResults": "<p>An optional limit for the number of geofences returned in a single call. </p> <p>Default value: <code>100</code> </p>"
}
},
"ListGeofencesResponse": {
"base": null,
"refs": {
}
},
"ListMapsRequest": {
"base": null,
"refs": {
}