aws-sdk-locationservice 1.24.0 → 1.26.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +44 -7
- data/lib/aws-sdk-locationservice/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-locationservice/endpoint_provider.rb +110 -0
- data/lib/aws-sdk-locationservice/endpoints.rb +757 -0
- data/lib/aws-sdk-locationservice/plugins/endpoints.rb +174 -0
- data/lib/aws-sdk-locationservice/types.rb +83 -732
- data/lib/aws-sdk-locationservice.rb +5 -1
- metadata +8 -4
@@ -24,14 +24,6 @@ module Aws::LocationService
|
|
24
24
|
include Aws::Structure
|
25
25
|
end
|
26
26
|
|
27
|
-
# @note When making an API call, you may pass AssociateTrackerConsumerRequest
|
28
|
-
# data as a hash:
|
29
|
-
#
|
30
|
-
# {
|
31
|
-
# consumer_arn: "Arn", # required
|
32
|
-
# tracker_name: "ResourceName", # required
|
33
|
-
# }
|
34
|
-
#
|
35
27
|
# @!attribute [rw] consumer_arn
|
36
28
|
# The Amazon Resource Name (ARN) for the geofence collection to be
|
37
29
|
# associated to tracker resource. Used when you need to specify a
|
@@ -81,14 +73,6 @@ module Aws::LocationService
|
|
81
73
|
include Aws::Structure
|
82
74
|
end
|
83
75
|
|
84
|
-
# @note When making an API call, you may pass BatchDeleteDevicePositionHistoryRequest
|
85
|
-
# data as a hash:
|
86
|
-
#
|
87
|
-
# {
|
88
|
-
# device_ids: ["Id"], # required
|
89
|
-
# tracker_name: "ResourceName", # required
|
90
|
-
# }
|
91
|
-
#
|
92
76
|
# @!attribute [rw] device_ids
|
93
77
|
# Devices whose position history you want to delete.
|
94
78
|
#
|
@@ -145,14 +129,6 @@ module Aws::LocationService
|
|
145
129
|
include Aws::Structure
|
146
130
|
end
|
147
131
|
|
148
|
-
# @note When making an API call, you may pass BatchDeleteGeofenceRequest
|
149
|
-
# data as a hash:
|
150
|
-
#
|
151
|
-
# {
|
152
|
-
# collection_name: "ResourceName", # required
|
153
|
-
# geofence_ids: ["Id"], # required
|
154
|
-
# }
|
155
|
-
#
|
156
132
|
# @!attribute [rw] collection_name
|
157
133
|
# The geofence collection storing the geofences to be deleted.
|
158
134
|
# @return [String]
|
@@ -212,26 +188,6 @@ module Aws::LocationService
|
|
212
188
|
include Aws::Structure
|
213
189
|
end
|
214
190
|
|
215
|
-
# @note When making an API call, you may pass BatchEvaluateGeofencesRequest
|
216
|
-
# data as a hash:
|
217
|
-
#
|
218
|
-
# {
|
219
|
-
# collection_name: "ResourceName", # required
|
220
|
-
# device_position_updates: [ # required
|
221
|
-
# {
|
222
|
-
# accuracy: {
|
223
|
-
# horizontal: 1.0, # required
|
224
|
-
# },
|
225
|
-
# device_id: "Id", # required
|
226
|
-
# position: [1.0], # required
|
227
|
-
# position_properties: {
|
228
|
-
# "PropertyMapKeyString" => "PropertyMapValueString",
|
229
|
-
# },
|
230
|
-
# sample_time: Time.now, # required
|
231
|
-
# },
|
232
|
-
# ],
|
233
|
-
# }
|
234
|
-
#
|
235
191
|
# @!attribute [rw] collection_name
|
236
192
|
# The geofence collection used in evaluating the position of devices
|
237
193
|
# against its geofences.
|
@@ -283,14 +239,6 @@ module Aws::LocationService
|
|
283
239
|
include Aws::Structure
|
284
240
|
end
|
285
241
|
|
286
|
-
# @note When making an API call, you may pass BatchGetDevicePositionRequest
|
287
|
-
# data as a hash:
|
288
|
-
#
|
289
|
-
# {
|
290
|
-
# device_ids: ["Id"], # required
|
291
|
-
# tracker_name: "BatchGetDevicePositionRequestTrackerNameString", # required
|
292
|
-
# }
|
293
|
-
#
|
294
242
|
# @!attribute [rw] device_ids
|
295
243
|
# Devices whose position you want to retrieve.
|
296
244
|
#
|
@@ -371,29 +319,6 @@ module Aws::LocationService
|
|
371
319
|
include Aws::Structure
|
372
320
|
end
|
373
321
|
|
374
|
-
# @note When making an API call, you may pass BatchPutGeofenceRequest
|
375
|
-
# data as a hash:
|
376
|
-
#
|
377
|
-
# {
|
378
|
-
# collection_name: "ResourceName", # required
|
379
|
-
# entries: [ # required
|
380
|
-
# {
|
381
|
-
# geofence_id: "Id", # required
|
382
|
-
# geometry: { # required
|
383
|
-
# circle: {
|
384
|
-
# center: [1.0], # required
|
385
|
-
# radius: 1.0, # required
|
386
|
-
# },
|
387
|
-
# polygon: [
|
388
|
-
# [
|
389
|
-
# [1.0],
|
390
|
-
# ],
|
391
|
-
# ],
|
392
|
-
# },
|
393
|
-
# },
|
394
|
-
# ],
|
395
|
-
# }
|
396
|
-
#
|
397
322
|
# @!attribute [rw] collection_name
|
398
323
|
# The geofence collection storing the geofences.
|
399
324
|
# @return [String]
|
@@ -413,24 +338,6 @@ module Aws::LocationService
|
|
413
338
|
|
414
339
|
# Contains geofence geometry details.
|
415
340
|
#
|
416
|
-
# @note When making an API call, you may pass BatchPutGeofenceRequestEntry
|
417
|
-
# data as a hash:
|
418
|
-
#
|
419
|
-
# {
|
420
|
-
# geofence_id: "Id", # required
|
421
|
-
# geometry: { # required
|
422
|
-
# circle: {
|
423
|
-
# center: [1.0], # required
|
424
|
-
# radius: 1.0, # required
|
425
|
-
# },
|
426
|
-
# polygon: [
|
427
|
-
# [
|
428
|
-
# [1.0],
|
429
|
-
# ],
|
430
|
-
# ],
|
431
|
-
# },
|
432
|
-
# }
|
433
|
-
#
|
434
341
|
# @!attribute [rw] geofence_id
|
435
342
|
# The identifier for the geofence to be stored in a given geofence
|
436
343
|
# collection.
|
@@ -544,26 +451,6 @@ module Aws::LocationService
|
|
544
451
|
include Aws::Structure
|
545
452
|
end
|
546
453
|
|
547
|
-
# @note When making an API call, you may pass BatchUpdateDevicePositionRequest
|
548
|
-
# data as a hash:
|
549
|
-
#
|
550
|
-
# {
|
551
|
-
# tracker_name: "ResourceName", # required
|
552
|
-
# updates: [ # required
|
553
|
-
# {
|
554
|
-
# accuracy: {
|
555
|
-
# horizontal: 1.0, # required
|
556
|
-
# },
|
557
|
-
# device_id: "Id", # required
|
558
|
-
# position: [1.0], # required
|
559
|
-
# position_properties: {
|
560
|
-
# "PropertyMapKeyString" => "PropertyMapValueString",
|
561
|
-
# },
|
562
|
-
# sample_time: Time.now, # required
|
563
|
-
# },
|
564
|
-
# ],
|
565
|
-
# }
|
566
|
-
#
|
567
454
|
# @!attribute [rw] tracker_name
|
568
455
|
# The name of the tracker resource to update.
|
569
456
|
# @return [String]
|
@@ -597,14 +484,6 @@ module Aws::LocationService
|
|
597
484
|
# Contains details about additional route preferences for requests that
|
598
485
|
# specify `TravelMode` as `Car`.
|
599
486
|
#
|
600
|
-
# @note When making an API call, you may pass CalculateRouteCarModeOptions
|
601
|
-
# data as a hash:
|
602
|
-
#
|
603
|
-
# {
|
604
|
-
# avoid_ferries: false,
|
605
|
-
# avoid_tolls: false,
|
606
|
-
# }
|
607
|
-
#
|
608
487
|
# @!attribute [rw] avoid_ferries
|
609
488
|
# Avoids ferries when calculating routes.
|
610
489
|
#
|
@@ -630,41 +509,6 @@ module Aws::LocationService
|
|
630
509
|
include Aws::Structure
|
631
510
|
end
|
632
511
|
|
633
|
-
# @note When making an API call, you may pass CalculateRouteMatrixRequest
|
634
|
-
# data as a hash:
|
635
|
-
#
|
636
|
-
# {
|
637
|
-
# calculator_name: "ResourceName", # required
|
638
|
-
# car_mode_options: {
|
639
|
-
# avoid_ferries: false,
|
640
|
-
# avoid_tolls: false,
|
641
|
-
# },
|
642
|
-
# depart_now: false,
|
643
|
-
# departure_positions: [ # required
|
644
|
-
# [1.0],
|
645
|
-
# ],
|
646
|
-
# departure_time: Time.now,
|
647
|
-
# destination_positions: [ # required
|
648
|
-
# [1.0],
|
649
|
-
# ],
|
650
|
-
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
651
|
-
# travel_mode: "Car", # accepts Car, Truck, Walking
|
652
|
-
# truck_mode_options: {
|
653
|
-
# avoid_ferries: false,
|
654
|
-
# avoid_tolls: false,
|
655
|
-
# dimensions: {
|
656
|
-
# height: 1.0,
|
657
|
-
# length: 1.0,
|
658
|
-
# unit: "Meters", # accepts Meters, Feet
|
659
|
-
# width: 1.0,
|
660
|
-
# },
|
661
|
-
# weight: {
|
662
|
-
# total: 1.0,
|
663
|
-
# unit: "Kilograms", # accepts Kilograms, Pounds
|
664
|
-
# },
|
665
|
-
# },
|
666
|
-
# }
|
667
|
-
#
|
668
512
|
# @!attribute [rw] calculator_name
|
669
513
|
# The name of the route calculator resource that you want to use to
|
670
514
|
# calculate the route matrix.
|
@@ -890,41 +734,6 @@ module Aws::LocationService
|
|
890
734
|
include Aws::Structure
|
891
735
|
end
|
892
736
|
|
893
|
-
# @note When making an API call, you may pass CalculateRouteRequest
|
894
|
-
# data as a hash:
|
895
|
-
#
|
896
|
-
# {
|
897
|
-
# calculator_name: "ResourceName", # required
|
898
|
-
# car_mode_options: {
|
899
|
-
# avoid_ferries: false,
|
900
|
-
# avoid_tolls: false,
|
901
|
-
# },
|
902
|
-
# depart_now: false,
|
903
|
-
# departure_position: [1.0], # required
|
904
|
-
# departure_time: Time.now,
|
905
|
-
# destination_position: [1.0], # required
|
906
|
-
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
907
|
-
# include_leg_geometry: false,
|
908
|
-
# travel_mode: "Car", # accepts Car, Truck, Walking
|
909
|
-
# truck_mode_options: {
|
910
|
-
# avoid_ferries: false,
|
911
|
-
# avoid_tolls: false,
|
912
|
-
# dimensions: {
|
913
|
-
# height: 1.0,
|
914
|
-
# length: 1.0,
|
915
|
-
# unit: "Meters", # accepts Meters, Feet
|
916
|
-
# width: 1.0,
|
917
|
-
# },
|
918
|
-
# weight: {
|
919
|
-
# total: 1.0,
|
920
|
-
# unit: "Kilograms", # accepts Kilograms, Pounds
|
921
|
-
# },
|
922
|
-
# },
|
923
|
-
# waypoint_positions: [
|
924
|
-
# [1.0],
|
925
|
-
# ],
|
926
|
-
# }
|
927
|
-
#
|
928
737
|
# @!attribute [rw] calculator_name
|
929
738
|
# The name of the route calculator resource that you want to use to
|
930
739
|
# calculate the route.
|
@@ -1219,24 +1028,6 @@ module Aws::LocationService
|
|
1219
1028
|
# Contains details about additional route preferences for requests that
|
1220
1029
|
# specify `TravelMode` as `Truck`.
|
1221
1030
|
#
|
1222
|
-
# @note When making an API call, you may pass CalculateRouteTruckModeOptions
|
1223
|
-
# data as a hash:
|
1224
|
-
#
|
1225
|
-
# {
|
1226
|
-
# avoid_ferries: false,
|
1227
|
-
# avoid_tolls: false,
|
1228
|
-
# dimensions: {
|
1229
|
-
# height: 1.0,
|
1230
|
-
# length: 1.0,
|
1231
|
-
# unit: "Meters", # accepts Meters, Feet
|
1232
|
-
# width: 1.0,
|
1233
|
-
# },
|
1234
|
-
# weight: {
|
1235
|
-
# total: 1.0,
|
1236
|
-
# unit: "Kilograms", # accepts Kilograms, Pounds
|
1237
|
-
# },
|
1238
|
-
# }
|
1239
|
-
#
|
1240
1031
|
# @!attribute [rw] avoid_ferries
|
1241
1032
|
# Avoids ferries when calculating routes.
|
1242
1033
|
#
|
@@ -1278,14 +1069,6 @@ module Aws::LocationService
|
|
1278
1069
|
|
1279
1070
|
# A circle on the earth, as defined by a center point and a radius.
|
1280
1071
|
#
|
1281
|
-
# @note When making an API call, you may pass Circle
|
1282
|
-
# data as a hash:
|
1283
|
-
#
|
1284
|
-
# {
|
1285
|
-
# center: [1.0], # required
|
1286
|
-
# radius: 1.0, # required
|
1287
|
-
# }
|
1288
|
-
#
|
1289
1072
|
# @!attribute [rw] center
|
1290
1073
|
# A single point geometry, specifying the center of the circle, using
|
1291
1074
|
# [WGS 84][1] coordinates, in the form `[longitude, latitude]`.
|
@@ -1322,20 +1105,6 @@ module Aws::LocationService
|
|
1322
1105
|
include Aws::Structure
|
1323
1106
|
end
|
1324
1107
|
|
1325
|
-
# @note When making an API call, you may pass CreateGeofenceCollectionRequest
|
1326
|
-
# data as a hash:
|
1327
|
-
#
|
1328
|
-
# {
|
1329
|
-
# collection_name: "ResourceName", # required
|
1330
|
-
# description: "ResourceDescription",
|
1331
|
-
# kms_key_id: "KmsKeyId",
|
1332
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1333
|
-
# pricing_plan_data_source: "String",
|
1334
|
-
# tags: {
|
1335
|
-
# "TagKey" => "TagValue",
|
1336
|
-
# },
|
1337
|
-
# }
|
1338
|
-
#
|
1339
1108
|
# @!attribute [rw] collection_name
|
1340
1109
|
# A custom name for the geofence collection.
|
1341
1110
|
#
|
@@ -1440,23 +1209,10 @@ module Aws::LocationService
|
|
1440
1209
|
include Aws::Structure
|
1441
1210
|
end
|
1442
1211
|
|
1443
|
-
# @note When making an API call, you may pass CreateMapRequest
|
1444
|
-
# data as a hash:
|
1445
|
-
#
|
1446
|
-
# {
|
1447
|
-
# configuration: { # required
|
1448
|
-
# style: "MapStyle", # required
|
1449
|
-
# },
|
1450
|
-
# description: "ResourceDescription",
|
1451
|
-
# map_name: "ResourceName", # required
|
1452
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1453
|
-
# tags: {
|
1454
|
-
# "TagKey" => "TagValue",
|
1455
|
-
# },
|
1456
|
-
# }
|
1457
|
-
#
|
1458
1212
|
# @!attribute [rw] configuration
|
1459
|
-
# Specifies the
|
1213
|
+
# Specifies the `MapConfiguration`, including the map style, for the
|
1214
|
+
# map resource that you create. The map style defines the look of maps
|
1215
|
+
# and the data provider for your map resource.
|
1460
1216
|
# @return [Types::MapConfiguration]
|
1461
1217
|
#
|
1462
1218
|
# @!attribute [rw] description
|
@@ -1529,7 +1285,7 @@ module Aws::LocationService
|
|
1529
1285
|
# The Amazon Resource Name (ARN) for the map resource. Used to specify
|
1530
1286
|
# a resource across all AWS.
|
1531
1287
|
#
|
1532
|
-
# * Format example: `arn:aws:geo:region:account-id:
|
1288
|
+
# * Format example: `arn:aws:geo:region:account-id:map/ExampleMap`
|
1533
1289
|
#
|
1534
1290
|
# ^
|
1535
1291
|
# @return [String]
|
@@ -1548,22 +1304,6 @@ module Aws::LocationService
|
|
1548
1304
|
include Aws::Structure
|
1549
1305
|
end
|
1550
1306
|
|
1551
|
-
# @note When making an API call, you may pass CreatePlaceIndexRequest
|
1552
|
-
# data as a hash:
|
1553
|
-
#
|
1554
|
-
# {
|
1555
|
-
# data_source: "String", # required
|
1556
|
-
# data_source_configuration: {
|
1557
|
-
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
1558
|
-
# },
|
1559
|
-
# description: "ResourceDescription",
|
1560
|
-
# index_name: "ResourceName", # required
|
1561
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1562
|
-
# tags: {
|
1563
|
-
# "TagKey" => "TagValue",
|
1564
|
-
# },
|
1565
|
-
# }
|
1566
|
-
#
|
1567
1307
|
# @!attribute [rw] data_source
|
1568
1308
|
# Specifies the geospatial data provider for the new place index.
|
1569
1309
|
#
|
@@ -1697,19 +1437,6 @@ module Aws::LocationService
|
|
1697
1437
|
include Aws::Structure
|
1698
1438
|
end
|
1699
1439
|
|
1700
|
-
# @note When making an API call, you may pass CreateRouteCalculatorRequest
|
1701
|
-
# data as a hash:
|
1702
|
-
#
|
1703
|
-
# {
|
1704
|
-
# calculator_name: "ResourceName", # required
|
1705
|
-
# data_source: "String", # required
|
1706
|
-
# description: "ResourceDescription",
|
1707
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1708
|
-
# tags: {
|
1709
|
-
# "TagKey" => "TagValue",
|
1710
|
-
# },
|
1711
|
-
# }
|
1712
|
-
#
|
1713
1440
|
# @!attribute [rw] calculator_name
|
1714
1441
|
# The name of the route calculator resource.
|
1715
1442
|
#
|
@@ -1845,21 +1572,6 @@ module Aws::LocationService
|
|
1845
1572
|
include Aws::Structure
|
1846
1573
|
end
|
1847
1574
|
|
1848
|
-
# @note When making an API call, you may pass CreateTrackerRequest
|
1849
|
-
# data as a hash:
|
1850
|
-
#
|
1851
|
-
# {
|
1852
|
-
# description: "ResourceDescription",
|
1853
|
-
# kms_key_id: "KmsKeyId",
|
1854
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1855
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1856
|
-
# pricing_plan_data_source: "String",
|
1857
|
-
# tags: {
|
1858
|
-
# "TagKey" => "TagValue",
|
1859
|
-
# },
|
1860
|
-
# tracker_name: "ResourceName", # required
|
1861
|
-
# }
|
1862
|
-
#
|
1863
1575
|
# @!attribute [rw] description
|
1864
1576
|
# An optional description for the tracker resource.
|
1865
1577
|
# @return [String]
|
@@ -2017,13 +1729,6 @@ module Aws::LocationService
|
|
2017
1729
|
#
|
2018
1730
|
# [1]: https://aws.amazon.com/service-terms/
|
2019
1731
|
#
|
2020
|
-
# @note When making an API call, you may pass DataSourceConfiguration
|
2021
|
-
# data as a hash:
|
2022
|
-
#
|
2023
|
-
# {
|
2024
|
-
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
2025
|
-
# }
|
2026
|
-
#
|
2027
1732
|
# @!attribute [rw] intended_use
|
2028
1733
|
# Specifies how the results of an operation will be stored by the
|
2029
1734
|
# caller.
|
@@ -2046,13 +1751,6 @@ module Aws::LocationService
|
|
2046
1751
|
include Aws::Structure
|
2047
1752
|
end
|
2048
1753
|
|
2049
|
-
# @note When making an API call, you may pass DeleteGeofenceCollectionRequest
|
2050
|
-
# data as a hash:
|
2051
|
-
#
|
2052
|
-
# {
|
2053
|
-
# collection_name: "ResourceName", # required
|
2054
|
-
# }
|
2055
|
-
#
|
2056
1754
|
# @!attribute [rw] collection_name
|
2057
1755
|
# The name of the geofence collection to be deleted.
|
2058
1756
|
# @return [String]
|
@@ -2069,13 +1767,6 @@ module Aws::LocationService
|
|
2069
1767
|
#
|
2070
1768
|
class DeleteGeofenceCollectionResponse < Aws::EmptyStructure; end
|
2071
1769
|
|
2072
|
-
# @note When making an API call, you may pass DeleteMapRequest
|
2073
|
-
# data as a hash:
|
2074
|
-
#
|
2075
|
-
# {
|
2076
|
-
# map_name: "ResourceName", # required
|
2077
|
-
# }
|
2078
|
-
#
|
2079
1770
|
# @!attribute [rw] map_name
|
2080
1771
|
# The name of the map resource to be deleted.
|
2081
1772
|
# @return [String]
|
@@ -2092,13 +1783,6 @@ module Aws::LocationService
|
|
2092
1783
|
#
|
2093
1784
|
class DeleteMapResponse < Aws::EmptyStructure; end
|
2094
1785
|
|
2095
|
-
# @note When making an API call, you may pass DeletePlaceIndexRequest
|
2096
|
-
# data as a hash:
|
2097
|
-
#
|
2098
|
-
# {
|
2099
|
-
# index_name: "ResourceName", # required
|
2100
|
-
# }
|
2101
|
-
#
|
2102
1786
|
# @!attribute [rw] index_name
|
2103
1787
|
# The name of the place index resource to be deleted.
|
2104
1788
|
# @return [String]
|
@@ -2115,13 +1799,6 @@ module Aws::LocationService
|
|
2115
1799
|
#
|
2116
1800
|
class DeletePlaceIndexResponse < Aws::EmptyStructure; end
|
2117
1801
|
|
2118
|
-
# @note When making an API call, you may pass DeleteRouteCalculatorRequest
|
2119
|
-
# data as a hash:
|
2120
|
-
#
|
2121
|
-
# {
|
2122
|
-
# calculator_name: "ResourceName", # required
|
2123
|
-
# }
|
2124
|
-
#
|
2125
1802
|
# @!attribute [rw] calculator_name
|
2126
1803
|
# The name of the route calculator resource to be deleted.
|
2127
1804
|
# @return [String]
|
@@ -2138,13 +1815,6 @@ module Aws::LocationService
|
|
2138
1815
|
#
|
2139
1816
|
class DeleteRouteCalculatorResponse < Aws::EmptyStructure; end
|
2140
1817
|
|
2141
|
-
# @note When making an API call, you may pass DeleteTrackerRequest
|
2142
|
-
# data as a hash:
|
2143
|
-
#
|
2144
|
-
# {
|
2145
|
-
# tracker_name: "ResourceName", # required
|
2146
|
-
# }
|
2147
|
-
#
|
2148
1818
|
# @!attribute [rw] tracker_name
|
2149
1819
|
# The name of the tracker resource to be deleted.
|
2150
1820
|
# @return [String]
|
@@ -2161,13 +1831,6 @@ module Aws::LocationService
|
|
2161
1831
|
#
|
2162
1832
|
class DeleteTrackerResponse < Aws::EmptyStructure; end
|
2163
1833
|
|
2164
|
-
# @note When making an API call, you may pass DescribeGeofenceCollectionRequest
|
2165
|
-
# data as a hash:
|
2166
|
-
#
|
2167
|
-
# {
|
2168
|
-
# collection_name: "ResourceName", # required
|
2169
|
-
# }
|
2170
|
-
#
|
2171
1834
|
# @!attribute [rw] collection_name
|
2172
1835
|
# The name of the geofence collection.
|
2173
1836
|
# @return [String]
|
@@ -2253,13 +1916,6 @@ module Aws::LocationService
|
|
2253
1916
|
include Aws::Structure
|
2254
1917
|
end
|
2255
1918
|
|
2256
|
-
# @note When making an API call, you may pass DescribeMapRequest
|
2257
|
-
# data as a hash:
|
2258
|
-
#
|
2259
|
-
# {
|
2260
|
-
# map_name: "ResourceName", # required
|
2261
|
-
# }
|
2262
|
-
#
|
2263
1919
|
# @!attribute [rw] map_name
|
2264
1920
|
# The name of the map resource.
|
2265
1921
|
# @return [String]
|
@@ -2297,7 +1953,7 @@ module Aws::LocationService
|
|
2297
1953
|
# The Amazon Resource Name (ARN) for the map resource. Used to specify
|
2298
1954
|
# a resource across all AWS.
|
2299
1955
|
#
|
2300
|
-
# * Format example: `arn:aws:geo:region:account-id:
|
1956
|
+
# * Format example: `arn:aws:geo:region:account-id:map/ExampleMap`
|
2301
1957
|
#
|
2302
1958
|
# ^
|
2303
1959
|
# @return [String]
|
@@ -2339,13 +1995,6 @@ module Aws::LocationService
|
|
2339
1995
|
include Aws::Structure
|
2340
1996
|
end
|
2341
1997
|
|
2342
|
-
# @note When making an API call, you may pass DescribePlaceIndexRequest
|
2343
|
-
# data as a hash:
|
2344
|
-
#
|
2345
|
-
# {
|
2346
|
-
# index_name: "ResourceName", # required
|
2347
|
-
# }
|
2348
|
-
#
|
2349
1998
|
# @!attribute [rw] index_name
|
2350
1999
|
# The name of the place index resource.
|
2351
2000
|
# @return [String]
|
@@ -2438,13 +2087,6 @@ module Aws::LocationService
|
|
2438
2087
|
include Aws::Structure
|
2439
2088
|
end
|
2440
2089
|
|
2441
|
-
# @note When making an API call, you may pass DescribeRouteCalculatorRequest
|
2442
|
-
# data as a hash:
|
2443
|
-
#
|
2444
|
-
# {
|
2445
|
-
# calculator_name: "ResourceName", # required
|
2446
|
-
# }
|
2447
|
-
#
|
2448
2090
|
# @!attribute [rw] calculator_name
|
2449
2091
|
# The name of the route calculator resource.
|
2450
2092
|
# @return [String]
|
@@ -2540,13 +2182,6 @@ module Aws::LocationService
|
|
2540
2182
|
include Aws::Structure
|
2541
2183
|
end
|
2542
2184
|
|
2543
|
-
# @note When making an API call, you may pass DescribeTrackerRequest
|
2544
|
-
# data as a hash:
|
2545
|
-
#
|
2546
|
-
# {
|
2547
|
-
# tracker_name: "ResourceName", # required
|
2548
|
-
# }
|
2549
|
-
#
|
2550
2185
|
# @!attribute [rw] tracker_name
|
2551
2186
|
# The name of the tracker resource.
|
2552
2187
|
# @return [String]
|
@@ -2688,21 +2323,6 @@ module Aws::LocationService
|
|
2688
2323
|
|
2689
2324
|
# Contains the position update details for a device.
|
2690
2325
|
#
|
2691
|
-
# @note When making an API call, you may pass DevicePositionUpdate
|
2692
|
-
# data as a hash:
|
2693
|
-
#
|
2694
|
-
# {
|
2695
|
-
# accuracy: {
|
2696
|
-
# horizontal: 1.0, # required
|
2697
|
-
# },
|
2698
|
-
# device_id: "Id", # required
|
2699
|
-
# position: [1.0], # required
|
2700
|
-
# position_properties: {
|
2701
|
-
# "PropertyMapKeyString" => "PropertyMapValueString",
|
2702
|
-
# },
|
2703
|
-
# sample_time: Time.now, # required
|
2704
|
-
# }
|
2705
|
-
#
|
2706
2326
|
# @!attribute [rw] accuracy
|
2707
2327
|
# The accuracy of the device position.
|
2708
2328
|
# @return [Types::PositionalAccuracy]
|
@@ -2749,14 +2369,6 @@ module Aws::LocationService
|
|
2749
2369
|
include Aws::Structure
|
2750
2370
|
end
|
2751
2371
|
|
2752
|
-
# @note When making an API call, you may pass DisassociateTrackerConsumerRequest
|
2753
|
-
# data as a hash:
|
2754
|
-
#
|
2755
|
-
# {
|
2756
|
-
# consumer_arn: "Arn", # required
|
2757
|
-
# tracker_name: "ResourceName", # required
|
2758
|
-
# }
|
2759
|
-
#
|
2760
2372
|
# @!attribute [rw] consumer_arn
|
2761
2373
|
# The Amazon Resource Name (ARN) for the geofence collection to be
|
2762
2374
|
# disassociated from the tracker resource. Used when you need to
|
@@ -2798,40 +2410,32 @@ module Aws::LocationService
|
|
2798
2410
|
#
|
2799
2411
|
# </note>
|
2800
2412
|
#
|
2801
|
-
# @note When making an API call, you may pass GeofenceGeometry
|
2802
|
-
# data as a hash:
|
2803
|
-
#
|
2804
|
-
# {
|
2805
|
-
# circle: {
|
2806
|
-
# center: [1.0], # required
|
2807
|
-
# radius: 1.0, # required
|
2808
|
-
# },
|
2809
|
-
# polygon: [
|
2810
|
-
# [
|
2811
|
-
# [1.0],
|
2812
|
-
# ],
|
2813
|
-
# ],
|
2814
|
-
# }
|
2815
|
-
#
|
2816
2413
|
# @!attribute [rw] circle
|
2817
2414
|
# A circle on the earth, as defined by a center point and a radius.
|
2818
2415
|
# @return [Types::Circle]
|
2819
2416
|
#
|
2820
2417
|
# @!attribute [rw] polygon
|
2821
|
-
#
|
2822
|
-
#
|
2823
|
-
#
|
2824
|
-
# form: `[longitude,
|
2825
|
-
#
|
2826
|
-
#
|
2827
|
-
#
|
2828
|
-
#
|
2829
|
-
#
|
2830
|
-
#
|
2831
|
-
#
|
2832
|
-
#
|
2833
|
-
#
|
2834
|
-
#
|
2418
|
+
# A polygon is a list of linear rings which are each made up of a list
|
2419
|
+
# of vertices.
|
2420
|
+
#
|
2421
|
+
# Each vertex is a 2-dimensional point of the form: `[longitude,
|
2422
|
+
# latitude]`. This is represented as an array of doubles of length 2
|
2423
|
+
# (so `[double, double]`).
|
2424
|
+
#
|
2425
|
+
# An array of 4 or more vertices, where the first and last vertex are
|
2426
|
+
# the same (to form a closed boundary), is called a linear ring. The
|
2427
|
+
# linear ring vertices must be listed in counter-clockwise order
|
2428
|
+
# around the ring’s interior. The linear ring is represented as an
|
2429
|
+
# array of vertices, or an array of arrays of doubles (`[[double,
|
2430
|
+
# double], ...]`).
|
2431
|
+
#
|
2432
|
+
# A geofence consists of a single linear ring. To allow for future
|
2433
|
+
# expansion, the Polygon parameter takes an array of linear rings,
|
2434
|
+
# which is represented as an array of arrays of arrays of doubles
|
2435
|
+
# (`[[[double, double], ...], ...]`).
|
2436
|
+
#
|
2437
|
+
# A linear ring for use in geofences can consist of between 4 and
|
2438
|
+
# 1,000 vertices.
|
2835
2439
|
# @return [Array<Array<Array<Float>>>]
|
2836
2440
|
#
|
2837
2441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GeofenceGeometry AWS API Documentation
|
@@ -2843,18 +2447,6 @@ module Aws::LocationService
|
|
2843
2447
|
include Aws::Structure
|
2844
2448
|
end
|
2845
2449
|
|
2846
|
-
# @note When making an API call, you may pass GetDevicePositionHistoryRequest
|
2847
|
-
# data as a hash:
|
2848
|
-
#
|
2849
|
-
# {
|
2850
|
-
# device_id: "Id", # required
|
2851
|
-
# end_time_exclusive: Time.now,
|
2852
|
-
# max_results: 1,
|
2853
|
-
# next_token: "Token",
|
2854
|
-
# start_time_inclusive: Time.now,
|
2855
|
-
# tracker_name: "ResourceName", # required
|
2856
|
-
# }
|
2857
|
-
#
|
2858
2450
|
# @!attribute [rw] device_id
|
2859
2451
|
# The device whose position history you want to retrieve.
|
2860
2452
|
# @return [String]
|
@@ -2945,14 +2537,6 @@ module Aws::LocationService
|
|
2945
2537
|
include Aws::Structure
|
2946
2538
|
end
|
2947
2539
|
|
2948
|
-
# @note When making an API call, you may pass GetDevicePositionRequest
|
2949
|
-
# data as a hash:
|
2950
|
-
#
|
2951
|
-
# {
|
2952
|
-
# device_id: "Id", # required
|
2953
|
-
# tracker_name: "ResourceName", # required
|
2954
|
-
# }
|
2955
|
-
#
|
2956
2540
|
# @!attribute [rw] device_id
|
2957
2541
|
# The device whose position you want to retrieve.
|
2958
2542
|
# @return [String]
|
@@ -3017,14 +2601,6 @@ module Aws::LocationService
|
|
3017
2601
|
include Aws::Structure
|
3018
2602
|
end
|
3019
2603
|
|
3020
|
-
# @note When making an API call, you may pass GetGeofenceRequest
|
3021
|
-
# data as a hash:
|
3022
|
-
#
|
3023
|
-
# {
|
3024
|
-
# collection_name: "ResourceName", # required
|
3025
|
-
# geofence_id: "Id", # required
|
3026
|
-
# }
|
3027
|
-
#
|
3028
2604
|
# @!attribute [rw] collection_name
|
3029
2605
|
# The geofence collection storing the target geofence.
|
3030
2606
|
# @return [String]
|
@@ -3096,15 +2672,6 @@ module Aws::LocationService
|
|
3096
2672
|
include Aws::Structure
|
3097
2673
|
end
|
3098
2674
|
|
3099
|
-
# @note When making an API call, you may pass GetMapGlyphsRequest
|
3100
|
-
# data as a hash:
|
3101
|
-
#
|
3102
|
-
# {
|
3103
|
-
# font_stack: "String", # required
|
3104
|
-
# font_unicode_range: "GetMapGlyphsRequestFontUnicodeRangeString", # required
|
3105
|
-
# map_name: "ResourceName", # required
|
3106
|
-
# }
|
3107
|
-
#
|
3108
2675
|
# @!attribute [rw] font_stack
|
3109
2676
|
# A comma-separated list of fonts to load glyphs from in order of
|
3110
2677
|
# preference. For example, `Noto Sans Regular, Arial Unicode`.
|
@@ -3131,14 +2698,32 @@ module Aws::LocationService
|
|
3131
2698
|
#
|
3132
2699
|
# * VectorHereContrast – `Fira GO Regular` \| `Fira GO Bold`
|
3133
2700
|
#
|
3134
|
-
# * VectorHereExplore, VectorHereExploreTruck
|
3135
|
-
# `Fira GO
|
3136
|
-
# `Noto Sans CJK JP
|
2701
|
+
# * VectorHereExplore, VectorHereExploreTruck,
|
2702
|
+
# HybridHereExploreSatellite – `Fira GO Italic` \| `Fira GO Map` \|
|
2703
|
+
# `Fira GO Map Bold` \| `Noto Sans CJK JP Bold` \| `Noto Sans CJK JP
|
2704
|
+
# Light` \| `Noto Sans CJK JP Regular`
|
2705
|
+
#
|
2706
|
+
# Valid font stacks for [Open Data (Preview)][3] styles:
|
2707
|
+
#
|
2708
|
+
# * VectorOpenDataStandardLight – `Amazon Ember Regular,Noto Sans
|
2709
|
+
# Regular` \| `Amazon Ember Bold,Noto Sans Bold` \| `Amazon Ember
|
2710
|
+
# Medium,Noto Sans Medium` \| `Amazon Ember Regular Italic,Noto Sans
|
2711
|
+
# Italic` \| `Amazon Ember Condensed RC Regular,Noto Sans Regular`
|
2712
|
+
# \| `Amazon Ember Condensed RC Bold,Noto Sans Bold`
|
2713
|
+
#
|
2714
|
+
# ^
|
2715
|
+
#
|
2716
|
+
# <note markdown="1"> The fonts used by `VectorOpenDataStandardLight` are combined fonts
|
2717
|
+
# that use `Amazon Ember` for most glyphs but `Noto Sans` for glyphs
|
2718
|
+
# unsupported by `Amazon Ember`.
|
2719
|
+
#
|
2720
|
+
# </note>
|
3137
2721
|
#
|
3138
2722
|
#
|
3139
2723
|
#
|
3140
2724
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
3141
2725
|
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
2726
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/open-data.html
|
3142
2727
|
# @return [String]
|
3143
2728
|
#
|
3144
2729
|
# @!attribute [rw] font_unicode_range
|
@@ -3179,14 +2764,6 @@ module Aws::LocationService
|
|
3179
2764
|
include Aws::Structure
|
3180
2765
|
end
|
3181
2766
|
|
3182
|
-
# @note When making an API call, you may pass GetMapSpritesRequest
|
3183
|
-
# data as a hash:
|
3184
|
-
#
|
3185
|
-
# {
|
3186
|
-
# file_name: "GetMapSpritesRequestFileNameString", # required
|
3187
|
-
# map_name: "ResourceName", # required
|
3188
|
-
# }
|
3189
|
-
#
|
3190
2767
|
# @!attribute [rw] file_name
|
3191
2768
|
# The name of the sprite file. Use the following file names for the
|
3192
2769
|
# sprite sheet:
|
@@ -3235,13 +2812,6 @@ module Aws::LocationService
|
|
3235
2812
|
include Aws::Structure
|
3236
2813
|
end
|
3237
2814
|
|
3238
|
-
# @note When making an API call, you may pass GetMapStyleDescriptorRequest
|
3239
|
-
# data as a hash:
|
3240
|
-
#
|
3241
|
-
# {
|
3242
|
-
# map_name: "ResourceName", # required
|
3243
|
-
# }
|
3244
|
-
#
|
3245
2815
|
# @!attribute [rw] map_name
|
3246
2816
|
# The map resource to retrieve the style descriptor from.
|
3247
2817
|
# @return [String]
|
@@ -3272,16 +2842,6 @@ module Aws::LocationService
|
|
3272
2842
|
include Aws::Structure
|
3273
2843
|
end
|
3274
2844
|
|
3275
|
-
# @note When making an API call, you may pass GetMapTileRequest
|
3276
|
-
# data as a hash:
|
3277
|
-
#
|
3278
|
-
# {
|
3279
|
-
# map_name: "ResourceName", # required
|
3280
|
-
# x: "GetMapTileRequestXString", # required
|
3281
|
-
# y: "GetMapTileRequestYString", # required
|
3282
|
-
# z: "GetMapTileRequestZString", # required
|
3283
|
-
# }
|
3284
|
-
#
|
3285
2845
|
# @!attribute [rw] map_name
|
3286
2846
|
# The map resource to retrieve the map tiles from.
|
3287
2847
|
# @return [String]
|
@@ -3327,15 +2887,6 @@ module Aws::LocationService
|
|
3327
2887
|
include Aws::Structure
|
3328
2888
|
end
|
3329
2889
|
|
3330
|
-
# @note When making an API call, you may pass GetPlaceRequest
|
3331
|
-
# data as a hash:
|
3332
|
-
#
|
3333
|
-
# {
|
3334
|
-
# index_name: "ResourceName", # required
|
3335
|
-
# language: "LanguageTag",
|
3336
|
-
# place_id: "PlaceId", # required
|
3337
|
-
# }
|
3338
|
-
#
|
3339
2890
|
# @!attribute [rw] index_name
|
3340
2891
|
# The name of the place index resource that you want to use for the
|
3341
2892
|
# search.
|
@@ -3522,15 +3073,6 @@ module Aws::LocationService
|
|
3522
3073
|
include Aws::Structure
|
3523
3074
|
end
|
3524
3075
|
|
3525
|
-
# @note When making an API call, you may pass ListDevicePositionsRequest
|
3526
|
-
# data as a hash:
|
3527
|
-
#
|
3528
|
-
# {
|
3529
|
-
# max_results: 1,
|
3530
|
-
# next_token: "Token",
|
3531
|
-
# tracker_name: "ResourceName", # required
|
3532
|
-
# }
|
3533
|
-
#
|
3534
3076
|
# @!attribute [rw] max_results
|
3535
3077
|
# An optional limit for the number of entries returned in a single
|
3536
3078
|
# call.
|
@@ -3622,14 +3164,6 @@ module Aws::LocationService
|
|
3622
3164
|
include Aws::Structure
|
3623
3165
|
end
|
3624
3166
|
|
3625
|
-
# @note When making an API call, you may pass ListGeofenceCollectionsRequest
|
3626
|
-
# data as a hash:
|
3627
|
-
#
|
3628
|
-
# {
|
3629
|
-
# max_results: 1,
|
3630
|
-
# next_token: "Token",
|
3631
|
-
# }
|
3632
|
-
#
|
3633
3167
|
# @!attribute [rw] max_results
|
3634
3168
|
# An optional limit for the number of resources returned in a single
|
3635
3169
|
# call.
|
@@ -3778,15 +3312,6 @@ module Aws::LocationService
|
|
3778
3312
|
include Aws::Structure
|
3779
3313
|
end
|
3780
3314
|
|
3781
|
-
# @note When making an API call, you may pass ListGeofencesRequest
|
3782
|
-
# data as a hash:
|
3783
|
-
#
|
3784
|
-
# {
|
3785
|
-
# collection_name: "ResourceName", # required
|
3786
|
-
# max_results: 1,
|
3787
|
-
# next_token: "Token",
|
3788
|
-
# }
|
3789
|
-
#
|
3790
3315
|
# @!attribute [rw] collection_name
|
3791
3316
|
# The name of the geofence collection storing the list of geofences.
|
3792
3317
|
# @return [String]
|
@@ -3835,14 +3360,6 @@ module Aws::LocationService
|
|
3835
3360
|
include Aws::Structure
|
3836
3361
|
end
|
3837
3362
|
|
3838
|
-
# @note When making an API call, you may pass ListMapsRequest
|
3839
|
-
# data as a hash:
|
3840
|
-
#
|
3841
|
-
# {
|
3842
|
-
# max_results: 1,
|
3843
|
-
# next_token: "Token",
|
3844
|
-
# }
|
3845
|
-
#
|
3846
3363
|
# @!attribute [rw] max_results
|
3847
3364
|
# An optional limit for the number of resources returned in a single
|
3848
3365
|
# call.
|
@@ -3935,14 +3452,6 @@ module Aws::LocationService
|
|
3935
3452
|
include Aws::Structure
|
3936
3453
|
end
|
3937
3454
|
|
3938
|
-
# @note When making an API call, you may pass ListPlaceIndexesRequest
|
3939
|
-
# data as a hash:
|
3940
|
-
#
|
3941
|
-
# {
|
3942
|
-
# max_results: 1,
|
3943
|
-
# next_token: "Token",
|
3944
|
-
# }
|
3945
|
-
#
|
3946
3455
|
# @!attribute [rw] max_results
|
3947
3456
|
# An optional limit for the maximum number of results returned in a
|
3948
3457
|
# single call.
|
@@ -4047,14 +3556,6 @@ module Aws::LocationService
|
|
4047
3556
|
include Aws::Structure
|
4048
3557
|
end
|
4049
3558
|
|
4050
|
-
# @note When making an API call, you may pass ListRouteCalculatorsRequest
|
4051
|
-
# data as a hash:
|
4052
|
-
#
|
4053
|
-
# {
|
4054
|
-
# max_results: 1,
|
4055
|
-
# next_token: "Token",
|
4056
|
-
# }
|
4057
|
-
#
|
4058
3559
|
# @!attribute [rw] max_results
|
4059
3560
|
# An optional maximum number of results returned in a single call.
|
4060
3561
|
#
|
@@ -4166,13 +3667,6 @@ module Aws::LocationService
|
|
4166
3667
|
include Aws::Structure
|
4167
3668
|
end
|
4168
3669
|
|
4169
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
4170
|
-
# data as a hash:
|
4171
|
-
#
|
4172
|
-
# {
|
4173
|
-
# resource_arn: "Arn", # required
|
4174
|
-
# }
|
4175
|
-
#
|
4176
3670
|
# @!attribute [rw] resource_arn
|
4177
3671
|
# The Amazon Resource Name (ARN) of the resource whose tags you want
|
4178
3672
|
# to retrieve.
|
@@ -4208,15 +3702,6 @@ module Aws::LocationService
|
|
4208
3702
|
include Aws::Structure
|
4209
3703
|
end
|
4210
3704
|
|
4211
|
-
# @note When making an API call, you may pass ListTrackerConsumersRequest
|
4212
|
-
# data as a hash:
|
4213
|
-
#
|
4214
|
-
# {
|
4215
|
-
# max_results: 1,
|
4216
|
-
# next_token: "Token",
|
4217
|
-
# tracker_name: "ResourceName", # required
|
4218
|
-
# }
|
4219
|
-
#
|
4220
3705
|
# @!attribute [rw] max_results
|
4221
3706
|
# An optional limit for the number of resources returned in a single
|
4222
3707
|
# call.
|
@@ -4267,14 +3752,6 @@ module Aws::LocationService
|
|
4267
3752
|
include Aws::Structure
|
4268
3753
|
end
|
4269
3754
|
|
4270
|
-
# @note When making an API call, you may pass ListTrackersRequest
|
4271
|
-
# data as a hash:
|
4272
|
-
#
|
4273
|
-
# {
|
4274
|
-
# max_results: 1,
|
4275
|
-
# next_token: "Token",
|
4276
|
-
# }
|
4277
|
-
#
|
4278
3755
|
# @!attribute [rw] max_results
|
4279
3756
|
# An optional limit for the number of resources returned in a single
|
4280
3757
|
# call.
|
@@ -4371,13 +3848,6 @@ module Aws::LocationService
|
|
4371
3848
|
|
4372
3849
|
# Specifies the map tile style selected from an available provider.
|
4373
3850
|
#
|
4374
|
-
# @note When making an API call, you may pass MapConfiguration
|
4375
|
-
# data as a hash:
|
4376
|
-
#
|
4377
|
-
# {
|
4378
|
-
# style: "MapStyle", # required
|
4379
|
-
# }
|
4380
|
-
#
|
4381
3851
|
# @!attribute [rw] style
|
4382
3852
|
# Specifies the map style selected from an available data provider.
|
4383
3853
|
#
|
@@ -4417,6 +3887,12 @@ module Aws::LocationService
|
|
4417
3887
|
# high contrast detailed base map of the world that blends 3D and 2D
|
4418
3888
|
# rendering.
|
4419
3889
|
#
|
3890
|
+
# <note markdown="1"> The `VectorHereContrast` style has been renamed from
|
3891
|
+
# `VectorHereBerlin`. `VectorHereBerlin` has been deprecated, but
|
3892
|
+
# will continue to work in applications that use it.
|
3893
|
+
#
|
3894
|
+
# </note>
|
3895
|
+
#
|
4420
3896
|
# * `VectorHereExplore` – A default HERE map style containing a
|
4421
3897
|
# neutral, global map and its features including roads, buildings,
|
4422
3898
|
# landmarks, and water features. It also now includes a fully
|
@@ -4427,16 +3903,40 @@ module Aws::LocationService
|
|
4427
3903
|
# symbolized with highlighted segments and icons on top of HERE
|
4428
3904
|
# Explore to support use cases within transport and logistics.
|
4429
3905
|
#
|
4430
|
-
#
|
4431
|
-
#
|
4432
|
-
# continue to work in applications that use it.
|
3906
|
+
# * `RasterHereExploreSatellite` – A global map containing high
|
3907
|
+
# resolution satellite imagery.
|
4433
3908
|
#
|
4434
|
-
#
|
3909
|
+
# * `HybridHereExploreSatellite` – A global map displaying the road
|
3910
|
+
# network, street names, and city labels over satellite imagery.
|
3911
|
+
# This style will automatically retrieve both raster and vector
|
3912
|
+
# tiles, and your charges will be based on total tiles retrieved.
|
3913
|
+
#
|
3914
|
+
# <note markdown="1"> Hybrid styles use both vector and raster tiles when rendering the
|
3915
|
+
# map that you see. This means that more tiles are retrieved than
|
3916
|
+
# when using either vector or raster tiles alone. Your charges will
|
3917
|
+
# include all tiles retrieved.
|
3918
|
+
#
|
3919
|
+
# </note>
|
3920
|
+
#
|
3921
|
+
# Valid [Open Data (Preview) map styles][3]\:
|
3922
|
+
#
|
3923
|
+
# * `VectorOpenDataStandardLight` – The Open Data Standard Light
|
3924
|
+
# (preview) map style provides a detailed basemap for the world
|
3925
|
+
# suitable for website and mobile application use. The map includes
|
3926
|
+
# highways major roads, minor roads, railways, water features,
|
3927
|
+
# cities, parks, landmarks, building footprints, and administrative
|
3928
|
+
# boundaries.
|
3929
|
+
#
|
3930
|
+
# Open Data maps is in preview. We may add, change, or remove
|
3931
|
+
# features before announcing general availability. For more
|
3932
|
+
# information, see [Open Data is in preview release][4].
|
4435
3933
|
#
|
4436
3934
|
#
|
4437
3935
|
#
|
4438
3936
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
4439
3937
|
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
3938
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/open-data.html
|
3939
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/open-data.html#open-data-preview
|
4440
3940
|
# @return [String]
|
4441
3941
|
#
|
4442
3942
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/MapConfiguration AWS API Documentation
|
@@ -4519,7 +4019,7 @@ module Aws::LocationService
|
|
4519
4019
|
#
|
4520
4020
|
# @!attribute [rw] time_zone
|
4521
4021
|
# The time zone in which the `Place` is located. Returned only when
|
4522
|
-
# using
|
4022
|
+
# using HERE as the selected partner.
|
4523
4023
|
# @return [Types::TimeZone]
|
4524
4024
|
#
|
4525
4025
|
# @!attribute [rw] unit_number
|
@@ -4583,13 +4083,6 @@ module Aws::LocationService
|
|
4583
4083
|
|
4584
4084
|
# Defines the level of certainty of the position.
|
4585
4085
|
#
|
4586
|
-
# @note When making an API call, you may pass PositionalAccuracy
|
4587
|
-
# data as a hash:
|
4588
|
-
#
|
4589
|
-
# {
|
4590
|
-
# horizontal: 1.0, # required
|
4591
|
-
# }
|
4592
|
-
#
|
4593
4086
|
# @!attribute [rw] horizontal
|
4594
4087
|
# Estimated maximum distance, in meters, between the measured position
|
4595
4088
|
# and the true position of a device, along the Earth's surface.
|
@@ -4603,25 +4096,6 @@ module Aws::LocationService
|
|
4603
4096
|
include Aws::Structure
|
4604
4097
|
end
|
4605
4098
|
|
4606
|
-
# @note When making an API call, you may pass PutGeofenceRequest
|
4607
|
-
# data as a hash:
|
4608
|
-
#
|
4609
|
-
# {
|
4610
|
-
# collection_name: "ResourceName", # required
|
4611
|
-
# geofence_id: "Id", # required
|
4612
|
-
# geometry: { # required
|
4613
|
-
# circle: {
|
4614
|
-
# center: [1.0], # required
|
4615
|
-
# radius: 1.0, # required
|
4616
|
-
# },
|
4617
|
-
# polygon: [
|
4618
|
-
# [
|
4619
|
-
# [1.0],
|
4620
|
-
# ],
|
4621
|
-
# ],
|
4622
|
-
# },
|
4623
|
-
# }
|
4624
|
-
#
|
4625
4099
|
# @!attribute [rw] collection_name
|
4626
4100
|
# The geofence collection to store the geofence in.
|
4627
4101
|
# @return [String]
|
@@ -4894,16 +4368,6 @@ module Aws::LocationService
|
|
4894
4368
|
include Aws::Structure
|
4895
4369
|
end
|
4896
4370
|
|
4897
|
-
# @note When making an API call, you may pass SearchPlaceIndexForPositionRequest
|
4898
|
-
# data as a hash:
|
4899
|
-
#
|
4900
|
-
# {
|
4901
|
-
# index_name: "ResourceName", # required
|
4902
|
-
# language: "LanguageTag",
|
4903
|
-
# max_results: 1,
|
4904
|
-
# position: [1.0], # required
|
4905
|
-
# }
|
4906
|
-
#
|
4907
4371
|
# @!attribute [rw] index_name
|
4908
4372
|
# The name of the place index resource you want to use for the search.
|
4909
4373
|
# @return [String]
|
@@ -5032,19 +4496,6 @@ module Aws::LocationService
|
|
5032
4496
|
include Aws::Structure
|
5033
4497
|
end
|
5034
4498
|
|
5035
|
-
# @note When making an API call, you may pass SearchPlaceIndexForSuggestionsRequest
|
5036
|
-
# data as a hash:
|
5037
|
-
#
|
5038
|
-
# {
|
5039
|
-
# bias_position: [1.0],
|
5040
|
-
# filter_b_box: [1.0],
|
5041
|
-
# filter_countries: ["CountryCode"],
|
5042
|
-
# index_name: "ResourceName", # required
|
5043
|
-
# language: "LanguageTag",
|
5044
|
-
# max_results: 1,
|
5045
|
-
# text: "SearchPlaceIndexForSuggestionsRequestTextString", # required
|
5046
|
-
# }
|
5047
|
-
#
|
5048
4499
|
# @!attribute [rw] bias_position
|
5049
4500
|
# An optional parameter that indicates a preference for place
|
5050
4501
|
# suggestions that are closer to a specified position.
|
@@ -5244,19 +4695,6 @@ module Aws::LocationService
|
|
5244
4695
|
include Aws::Structure
|
5245
4696
|
end
|
5246
4697
|
|
5247
|
-
# @note When making an API call, you may pass SearchPlaceIndexForTextRequest
|
5248
|
-
# data as a hash:
|
5249
|
-
#
|
5250
|
-
# {
|
5251
|
-
# bias_position: [1.0],
|
5252
|
-
# filter_b_box: [1.0],
|
5253
|
-
# filter_countries: ["CountryCode"],
|
5254
|
-
# index_name: "ResourceName", # required
|
5255
|
-
# language: "LanguageTag",
|
5256
|
-
# max_results: 1,
|
5257
|
-
# text: "SearchPlaceIndexForTextRequestTextString", # required
|
5258
|
-
# }
|
5259
|
-
#
|
5260
4698
|
# @!attribute [rw] bias_position
|
5261
4699
|
# An optional parameter that indicates a preference for places that
|
5262
4700
|
# are closer to a specified position.
|
@@ -5537,16 +4975,6 @@ module Aws::LocationService
|
|
5537
4975
|
include Aws::Structure
|
5538
4976
|
end
|
5539
4977
|
|
5540
|
-
# @note When making an API call, you may pass TagResourceRequest
|
5541
|
-
# data as a hash:
|
5542
|
-
#
|
5543
|
-
# {
|
5544
|
-
# resource_arn: "Arn", # required
|
5545
|
-
# tags: { # required
|
5546
|
-
# "TagKey" => "TagValue",
|
5547
|
-
# },
|
5548
|
-
# }
|
5549
|
-
#
|
5550
4978
|
# @!attribute [rw] resource_arn
|
5551
4979
|
# The Amazon Resource Name (ARN) of the resource whose tags you want
|
5552
4980
|
# to update.
|
@@ -5637,16 +5065,6 @@ module Aws::LocationService
|
|
5637
5065
|
# allow the specified dimensions for requests that specify `TravelMode`
|
5638
5066
|
# as `Truck`.
|
5639
5067
|
#
|
5640
|
-
# @note When making an API call, you may pass TruckDimensions
|
5641
|
-
# data as a hash:
|
5642
|
-
#
|
5643
|
-
# {
|
5644
|
-
# height: 1.0,
|
5645
|
-
# length: 1.0,
|
5646
|
-
# unit: "Meters", # accepts Meters, Feet
|
5647
|
-
# width: 1.0,
|
5648
|
-
# }
|
5649
|
-
#
|
5650
5068
|
# @!attribute [rw] height
|
5651
5069
|
# The height of the truck.
|
5652
5070
|
#
|
@@ -5707,14 +5125,6 @@ module Aws::LocationService
|
|
5707
5125
|
# avoid roads that can't support or allow the total weight for requests
|
5708
5126
|
# that specify `TravelMode` as `Truck`.
|
5709
5127
|
#
|
5710
|
-
# @note When making an API call, you may pass TruckWeight
|
5711
|
-
# data as a hash:
|
5712
|
-
#
|
5713
|
-
# {
|
5714
|
-
# total: 1.0,
|
5715
|
-
# unit: "Kilograms", # accepts Kilograms, Pounds
|
5716
|
-
# }
|
5717
|
-
#
|
5718
5128
|
# @!attribute [rw] total
|
5719
5129
|
# The total weight of the truck.
|
5720
5130
|
#
|
@@ -5738,14 +5148,6 @@ module Aws::LocationService
|
|
5738
5148
|
include Aws::Structure
|
5739
5149
|
end
|
5740
5150
|
|
5741
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
5742
|
-
# data as a hash:
|
5743
|
-
#
|
5744
|
-
# {
|
5745
|
-
# resource_arn: "Arn", # required
|
5746
|
-
# tag_keys: ["String"], # required
|
5747
|
-
# }
|
5748
|
-
#
|
5749
5151
|
# @!attribute [rw] resource_arn
|
5750
5152
|
# The Amazon Resource Name (ARN) of the resource from which you want
|
5751
5153
|
# to remove tags.
|
@@ -5773,16 +5175,6 @@ module Aws::LocationService
|
|
5773
5175
|
#
|
5774
5176
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
5775
5177
|
|
5776
|
-
# @note When making an API call, you may pass UpdateGeofenceCollectionRequest
|
5777
|
-
# data as a hash:
|
5778
|
-
#
|
5779
|
-
# {
|
5780
|
-
# collection_name: "ResourceName", # required
|
5781
|
-
# description: "ResourceDescription",
|
5782
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
5783
|
-
# pricing_plan_data_source: "String",
|
5784
|
-
# }
|
5785
|
-
#
|
5786
5178
|
# @!attribute [rw] collection_name
|
5787
5179
|
# The name of the geofence collection to update.
|
5788
5180
|
# @return [String]
|
@@ -5844,15 +5236,6 @@ module Aws::LocationService
|
|
5844
5236
|
include Aws::Structure
|
5845
5237
|
end
|
5846
5238
|
|
5847
|
-
# @note When making an API call, you may pass UpdateMapRequest
|
5848
|
-
# data as a hash:
|
5849
|
-
#
|
5850
|
-
# {
|
5851
|
-
# description: "ResourceDescription",
|
5852
|
-
# map_name: "ResourceName", # required
|
5853
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
5854
|
-
# }
|
5855
|
-
#
|
5856
5239
|
# @!attribute [rw] description
|
5857
5240
|
# Updates the description for the map resource.
|
5858
5241
|
# @return [String]
|
@@ -5880,7 +5263,7 @@ module Aws::LocationService
|
|
5880
5263
|
# The Amazon Resource Name (ARN) of the updated map resource. Used to
|
5881
5264
|
# specify a resource across AWS.
|
5882
5265
|
#
|
5883
|
-
# * Format example: `arn:aws:geo:region:account-id:
|
5266
|
+
# * Format example: `arn:aws:geo:region:account-id:map/ExampleMap`
|
5884
5267
|
#
|
5885
5268
|
# ^
|
5886
5269
|
# @return [String]
|
@@ -5908,18 +5291,6 @@ module Aws::LocationService
|
|
5908
5291
|
include Aws::Structure
|
5909
5292
|
end
|
5910
5293
|
|
5911
|
-
# @note When making an API call, you may pass UpdatePlaceIndexRequest
|
5912
|
-
# data as a hash:
|
5913
|
-
#
|
5914
|
-
# {
|
5915
|
-
# data_source_configuration: {
|
5916
|
-
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
5917
|
-
# },
|
5918
|
-
# description: "ResourceDescription",
|
5919
|
-
# index_name: "ResourceName", # required
|
5920
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
5921
|
-
# }
|
5922
|
-
#
|
5923
5294
|
# @!attribute [rw] data_source_configuration
|
5924
5295
|
# Updates the data storage option for the place index resource.
|
5925
5296
|
# @return [Types::DataSourceConfiguration]
|
@@ -5981,15 +5352,6 @@ module Aws::LocationService
|
|
5981
5352
|
include Aws::Structure
|
5982
5353
|
end
|
5983
5354
|
|
5984
|
-
# @note When making an API call, you may pass UpdateRouteCalculatorRequest
|
5985
|
-
# data as a hash:
|
5986
|
-
#
|
5987
|
-
# {
|
5988
|
-
# calculator_name: "ResourceName", # required
|
5989
|
-
# description: "ResourceDescription",
|
5990
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
5991
|
-
# }
|
5992
|
-
#
|
5993
5355
|
# @!attribute [rw] calculator_name
|
5994
5356
|
# The name of the route calculator resource to update.
|
5995
5357
|
# @return [String]
|
@@ -6046,17 +5408,6 @@ module Aws::LocationService
|
|
6046
5408
|
include Aws::Structure
|
6047
5409
|
end
|
6048
5410
|
|
6049
|
-
# @note When making an API call, you may pass UpdateTrackerRequest
|
6050
|
-
# data as a hash:
|
6051
|
-
#
|
6052
|
-
# {
|
6053
|
-
# description: "ResourceDescription",
|
6054
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
6055
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
6056
|
-
# pricing_plan_data_source: "String",
|
6057
|
-
# tracker_name: "ResourceName", # required
|
6058
|
-
# }
|
6059
|
-
#
|
6060
5411
|
# @!attribute [rw] description
|
6061
5412
|
# Updates the description for the tracker resource.
|
6062
5413
|
# @return [String]
|