aws-sdk-locationservice 1.13.0 → 1.17.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.
@@ -219,8 +219,14 @@ module Aws::LocationService
219
219
  # collection_name: "ResourceName", # required
220
220
  # device_position_updates: [ # required
221
221
  # {
222
+ # accuracy: {
223
+ # horizontal: 1.0, # required
224
+ # },
222
225
  # device_id: "Id", # required
223
226
  # position: [1.0], # required
227
+ # position_properties: {
228
+ # "PropertyMapKeyString" => "PropertyMapValueString",
229
+ # },
224
230
  # sample_time: Time.now, # required
225
231
  # },
226
232
  # ],
@@ -536,8 +542,14 @@ module Aws::LocationService
536
542
  # tracker_name: "ResourceName", # required
537
543
  # updates: [ # required
538
544
  # {
545
+ # accuracy: {
546
+ # horizontal: 1.0, # required
547
+ # },
539
548
  # device_id: "Id", # required
540
549
  # position: [1.0], # required
550
+ # position_properties: {
551
+ # "PropertyMapKeyString" => "PropertyMapValueString",
552
+ # },
541
553
  # sample_time: Time.now, # required
542
554
  # },
543
555
  # ],
@@ -609,6 +621,266 @@ module Aws::LocationService
609
621
  include Aws::Structure
610
622
  end
611
623
 
624
+ # @note When making an API call, you may pass CalculateRouteMatrixRequest
625
+ # data as a hash:
626
+ #
627
+ # {
628
+ # calculator_name: "ResourceName", # required
629
+ # car_mode_options: {
630
+ # avoid_ferries: false,
631
+ # avoid_tolls: false,
632
+ # },
633
+ # depart_now: false,
634
+ # departure_positions: [ # required
635
+ # [1.0],
636
+ # ],
637
+ # departure_time: Time.now,
638
+ # destination_positions: [ # required
639
+ # [1.0],
640
+ # ],
641
+ # distance_unit: "Kilometers", # accepts Kilometers, Miles
642
+ # travel_mode: "Car", # accepts Car, Truck, Walking
643
+ # truck_mode_options: {
644
+ # avoid_ferries: false,
645
+ # avoid_tolls: false,
646
+ # dimensions: {
647
+ # height: 1.0,
648
+ # length: 1.0,
649
+ # unit: "Meters", # accepts Meters, Feet
650
+ # width: 1.0,
651
+ # },
652
+ # weight: {
653
+ # total: 1.0,
654
+ # unit: "Kilograms", # accepts Kilograms, Pounds
655
+ # },
656
+ # },
657
+ # }
658
+ #
659
+ # @!attribute [rw] calculator_name
660
+ # The name of the route calculator resource that you want to use to
661
+ # calculate the route matrix.
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] car_mode_options
665
+ # Specifies route preferences when traveling by `Car`, such as
666
+ # avoiding routes that use ferries or tolls.
667
+ #
668
+ # Requirements: `TravelMode` must be specified as `Car`.
669
+ # @return [Types::CalculateRouteCarModeOptions]
670
+ #
671
+ # @!attribute [rw] depart_now
672
+ # Sets the time of departure as the current time. Uses the current
673
+ # time to calculate the route matrix. You can't set both
674
+ # `DepartureTime` and `DepartNow`. If neither is set, the best time of
675
+ # day to travel with the best traffic conditions is used to calculate
676
+ # the route matrix.
677
+ #
678
+ # Default Value: `false`
679
+ #
680
+ # Valid Values: `false` \| `true`
681
+ # @return [Boolean]
682
+ #
683
+ # @!attribute [rw] departure_positions
684
+ # The list of departure (origin) positions for the route matrix. An
685
+ # array of points, each of which is itself a 2-value array defined in
686
+ # [WGS 84][1] format: `[longitude, latitude]`. For example,
687
+ # `[-123.115, 49.285]`.
688
+ #
689
+ # Depending on the data provider selected in the route calculator
690
+ # resource there may be additional restrictions on the inputs you can
691
+ # choose. See [ Position restrictions][2] in the *Amazon Location
692
+ # Service Developer Guide*.
693
+ #
694
+ # <note markdown="1"> For route calculators that use Esri as the data provider, if you
695
+ # specify a departure that's not located on a road, Amazon Location [
696
+ # moves the position to the nearest road][3]. The snapped value is
697
+ # available in the result in `SnappedDeparturePositions`.
698
+ #
699
+ # </note>
700
+ #
701
+ # Valid Values: `[-180 to 180,-90 to 90]`
702
+ #
703
+ #
704
+ #
705
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
706
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
707
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
708
+ # @return [Array<Array<Float>>]
709
+ #
710
+ # @!attribute [rw] departure_time
711
+ # Specifies the desired time of departure. Uses the given time to
712
+ # calculate the route matrix. You can't set both `DepartureTime` and
713
+ # `DepartNow`. If neither is set, the best time of day to travel with
714
+ # the best traffic conditions is used to calculate the route matrix.
715
+ #
716
+ # <note markdown="1"> Setting a departure time in the past returns a `400
717
+ # ValidationException` error.
718
+ #
719
+ # </note>
720
+ #
721
+ # * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
722
+ # `2020–07-2T12:15:20.000Z+01:00`
723
+ #
724
+ # ^
725
+ #
726
+ #
727
+ #
728
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
729
+ # @return [Time]
730
+ #
731
+ # @!attribute [rw] destination_positions
732
+ # The list of destination positions for the route matrix. An array of
733
+ # points, each of which is itself a 2-value array defined in [WGS
734
+ # 84][1] format: `[longitude, latitude]`. For example, `[-122.339,
735
+ # 47.615]`
736
+ #
737
+ # Depending on the data provider selected in the route calculator
738
+ # resource there may be additional restrictions on the inputs you can
739
+ # choose. See [ Position restrictions][2] in the *Amazon Location
740
+ # Service Developer Guide*.
741
+ #
742
+ # <note markdown="1"> For route calculators that use Esri as the data provider, if you
743
+ # specify a destination that's not located on a road, Amazon Location
744
+ # [ moves the position to the nearest road][3]. The snapped value is
745
+ # available in the result in `SnappedDestinationPositions`.
746
+ #
747
+ # </note>
748
+ #
749
+ # Valid Values: `[-180 to 180,-90 to 90]`
750
+ #
751
+ #
752
+ #
753
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
754
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
755
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
756
+ # @return [Array<Array<Float>>]
757
+ #
758
+ # @!attribute [rw] distance_unit
759
+ # Set the unit system to specify the distance.
760
+ #
761
+ # Default Value: `Kilometers`
762
+ # @return [String]
763
+ #
764
+ # @!attribute [rw] travel_mode
765
+ # Specifies the mode of transport when calculating a route. Used in
766
+ # estimating the speed of travel and road compatibility.
767
+ #
768
+ # The `TravelMode` you specify also determines how you specify route
769
+ # preferences:
770
+ #
771
+ # * If traveling by `Car` use the `CarModeOptions` parameter.
772
+ #
773
+ # * If traveling by `Truck` use the `TruckModeOptions` parameter.
774
+ #
775
+ # Default Value: `Car`
776
+ # @return [String]
777
+ #
778
+ # @!attribute [rw] truck_mode_options
779
+ # Specifies route preferences when traveling by `Truck`, such as
780
+ # avoiding routes that use ferries or tolls, and truck specifications
781
+ # to consider when choosing an optimal road.
782
+ #
783
+ # Requirements: `TravelMode` must be specified as `Truck`.
784
+ # @return [Types::CalculateRouteTruckModeOptions]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrixRequest AWS API Documentation
787
+ #
788
+ class CalculateRouteMatrixRequest < Struct.new(
789
+ :calculator_name,
790
+ :car_mode_options,
791
+ :depart_now,
792
+ :departure_positions,
793
+ :departure_time,
794
+ :destination_positions,
795
+ :distance_unit,
796
+ :travel_mode,
797
+ :truck_mode_options)
798
+ SENSITIVE = []
799
+ include Aws::Structure
800
+ end
801
+
802
+ # Returns the result of the route matrix calculation.
803
+ #
804
+ # @!attribute [rw] route_matrix
805
+ # The calculated route matrix containing the results for all pairs of
806
+ # `DeparturePositions` to `DestinationPositions`. Each row corresponds
807
+ # to one entry in `DeparturePositions`. Each entry in the row
808
+ # corresponds to the route from that entry in `DeparturePositions` to
809
+ # an entry in `DestinationPositions`.
810
+ # @return [Array<Array<Types::RouteMatrixEntry>>]
811
+ #
812
+ # @!attribute [rw] snapped_departure_positions
813
+ # For routes calculated using an Esri route calculator resource,
814
+ # departure positions are snapped to the closest road. For Esri route
815
+ # calculator resources, this returns the list of departure/origin
816
+ # positions used for calculation of the `RouteMatrix`.
817
+ # @return [Array<Array<Float>>]
818
+ #
819
+ # @!attribute [rw] snapped_destination_positions
820
+ # The list of destination positions for the route matrix used for
821
+ # calculation of the `RouteMatrix`.
822
+ # @return [Array<Array<Float>>]
823
+ #
824
+ # @!attribute [rw] summary
825
+ # Contains information about the route matrix, `DataSource`,
826
+ # `DistanceUnit`, `RouteCount` and `ErrorCount`.
827
+ # @return [Types::CalculateRouteMatrixSummary]
828
+ #
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrixResponse AWS API Documentation
830
+ #
831
+ class CalculateRouteMatrixResponse < Struct.new(
832
+ :route_matrix,
833
+ :snapped_departure_positions,
834
+ :snapped_destination_positions,
835
+ :summary)
836
+ SENSITIVE = []
837
+ include Aws::Structure
838
+ end
839
+
840
+ # A summary of the calculated route matrix.
841
+ #
842
+ # @!attribute [rw] data_source
843
+ # The data provider of traffic and road network data used to calculate
844
+ # the routes. Indicates one of the available providers:
845
+ #
846
+ # * `Esri`
847
+ #
848
+ # * `Here`
849
+ #
850
+ # For more information about data providers, see [Amazon Location
851
+ # Service data providers][1].
852
+ #
853
+ #
854
+ #
855
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
856
+ # @return [String]
857
+ #
858
+ # @!attribute [rw] distance_unit
859
+ # The unit of measurement for route distances.
860
+ # @return [String]
861
+ #
862
+ # @!attribute [rw] error_count
863
+ # The count of error results in the route matrix. If this number is 0,
864
+ # all routes were calculated successfully.
865
+ # @return [Integer]
866
+ #
867
+ # @!attribute [rw] route_count
868
+ # The count of cells in the route matrix. Equal to the number of
869
+ # `DeparturePositions` multiplied by the number of
870
+ # `DestinationPositions`.
871
+ # @return [Integer]
872
+ #
873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrixSummary AWS API Documentation
874
+ #
875
+ class CalculateRouteMatrixSummary < Struct.new(
876
+ :data_source,
877
+ :distance_unit,
878
+ :error_count,
879
+ :route_count)
880
+ SENSITIVE = []
881
+ include Aws::Structure
882
+ end
883
+
612
884
  # @note When making an API call, you may pass CalculateRouteRequest
613
885
  # data as a hash:
614
886
  #
@@ -686,7 +958,7 @@ module Aws::LocationService
686
958
  #
687
959
  #
688
960
  # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
689
- # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
961
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
690
962
  # @return [Array<Float>]
691
963
  #
692
964
  # @!attribute [rw] departure_time
@@ -727,7 +999,7 @@ module Aws::LocationService
727
999
  #
728
1000
  #
729
1001
  # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
730
- # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
1002
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
731
1003
  # @return [Array<Float>]
732
1004
  #
733
1005
  # @!attribute [rw] distance_unit
@@ -749,7 +1021,7 @@ module Aws::LocationService
749
1021
  # Specifies the mode of transport when calculating a route. Used in
750
1022
  # estimating the speed of travel and road compatibility.
751
1023
  #
752
- # The `TravelMode` you specify determines how you specify route
1024
+ # The `TravelMode` you specify also determines how you specify route
753
1025
  # preferences:
754
1026
  #
755
1027
  # * If traveling by `Car` use the `CarModeOptions` parameter.
@@ -794,7 +1066,7 @@ module Aws::LocationService
794
1066
  #
795
1067
  #
796
1068
  #
797
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
1069
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
798
1070
  # @return [Array<Array<Float>>]
799
1071
  #
800
1072
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteRequest AWS API Documentation
@@ -845,7 +1117,7 @@ module Aws::LocationService
845
1117
  #
846
1118
  #
847
1119
  #
848
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
1120
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
849
1121
  # @return [Array<Types::Leg>]
850
1122
  #
851
1123
  # @!attribute [rw] summary
@@ -1014,7 +1286,7 @@ module Aws::LocationService
1014
1286
  # collection_name: "ResourceName", # required
1015
1287
  # description: "ResourceDescription",
1016
1288
  # kms_key_id: "KmsKeyId",
1017
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1289
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1018
1290
  # pricing_plan_data_source: "String",
1019
1291
  # tags: {
1020
1292
  # "TagKey" => "TagValue",
@@ -1048,40 +1320,12 @@ module Aws::LocationService
1048
1320
  # @return [String]
1049
1321
  #
1050
1322
  # @!attribute [rw] pricing_plan
1051
- # Specifies the pricing plan for the geofence collection.
1052
- #
1053
- # For additional details and restrictions on each pricing plan option,
1054
- # see the [Amazon Location Service pricing page][1].
1055
- #
1056
- #
1057
- #
1058
- # [1]: https://aws.amazon.com/location/pricing/
1323
+ # No longer used. If included, the only allowed value is
1324
+ # `RequestBasedUsage`.
1059
1325
  # @return [String]
1060
1326
  #
1061
1327
  # @!attribute [rw] pricing_plan_data_source
1062
- # Specifies the data provider for the geofence collection.
1063
- #
1064
- # * Required value for the following pricing plans:
1065
- # `MobileAssetTracking `\| `MobileAssetManagement`
1066
- #
1067
- # ^
1068
- #
1069
- # For more information about [Data Providers][1], and [Pricing
1070
- # plans][2], see the Amazon Location Service product page.
1071
- #
1072
- # <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to
1073
- # calculate billing for your geofence collection. Your data won't be
1074
- # shared with the data provider, and will remain in your AWS account
1075
- # or Region unless you move it.
1076
- #
1077
- # </note>
1078
- #
1079
- # Valid Values: `Esri `\| `Here`
1080
- #
1081
- #
1082
- #
1083
- # [1]: https://aws.amazon.com/location/data-providers/
1084
- # [2]: https://aws.amazon.com/location/pricing/
1328
+ # This parameter is no longer used.
1085
1329
  # @return [String]
1086
1330
  #
1087
1331
  # @!attribute [rw] tags
@@ -1162,7 +1406,7 @@ module Aws::LocationService
1162
1406
  # },
1163
1407
  # description: "ResourceDescription",
1164
1408
  # map_name: "ResourceName", # required
1165
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1409
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1166
1410
  # tags: {
1167
1411
  # "TagKey" => "TagValue",
1168
1412
  # },
@@ -1190,14 +1434,8 @@ module Aws::LocationService
1190
1434
  # @return [String]
1191
1435
  #
1192
1436
  # @!attribute [rw] pricing_plan
1193
- # Specifies the pricing plan for your map resource.
1194
- #
1195
- # For additional details and restrictions on each pricing plan option,
1196
- # see [Amazon Location Service pricing][1].
1197
- #
1198
- #
1199
- #
1200
- # [1]: https://aws.amazon.com/location/pricing/
1437
+ # No longer used. If included, the only allowed value is
1438
+ # `RequestBasedUsage`.
1201
1439
  # @return [String]
1202
1440
  #
1203
1441
  # @!attribute [rw] tags
@@ -1277,7 +1515,7 @@ module Aws::LocationService
1277
1515
  # },
1278
1516
  # description: "ResourceDescription",
1279
1517
  # index_name: "ResourceName", # required
1280
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1518
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1281
1519
  # tags: {
1282
1520
  # "TagKey" => "TagValue",
1283
1521
  # },
@@ -1342,14 +1580,8 @@ module Aws::LocationService
1342
1580
  # @return [String]
1343
1581
  #
1344
1582
  # @!attribute [rw] pricing_plan
1345
- # Specifies the pricing plan for your place index resource.
1346
- #
1347
- # For additional details and restrictions on each pricing plan option,
1348
- # see [Amazon Location Service pricing][1].
1349
- #
1350
- #
1351
- #
1352
- # [1]: https://aws.amazon.com/location/pricing/
1583
+ # No longer used. If included, the only allowed value is
1584
+ # `RequestBasedUsage`.
1353
1585
  # @return [String]
1354
1586
  #
1355
1587
  # @!attribute [rw] tags
@@ -1429,7 +1661,7 @@ module Aws::LocationService
1429
1661
  # calculator_name: "ResourceName", # required
1430
1662
  # data_source: "String", # required
1431
1663
  # description: "ResourceDescription",
1432
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1664
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1433
1665
  # tags: {
1434
1666
  # "TagKey" => "TagValue",
1435
1667
  # },
@@ -1486,14 +1718,8 @@ module Aws::LocationService
1486
1718
  # @return [String]
1487
1719
  #
1488
1720
  # @!attribute [rw] pricing_plan
1489
- # Specifies the pricing plan for your route calculator resource.
1490
- #
1491
- # For additional details and restrictions on each pricing plan option,
1492
- # see [Amazon Location Service pricing][1].
1493
- #
1494
- #
1495
- #
1496
- # [1]: https://aws.amazon.com/location/pricing/
1721
+ # No longer used. If included, the only allowed value is
1722
+ # `RequestBasedUsage`.
1497
1723
  # @return [String]
1498
1724
  #
1499
1725
  # @!attribute [rw] tags
@@ -1583,7 +1809,7 @@ module Aws::LocationService
1583
1809
  # description: "ResourceDescription",
1584
1810
  # kms_key_id: "KmsKeyId",
1585
1811
  # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
1586
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1812
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1587
1813
  # pricing_plan_data_source: "String",
1588
1814
  # tags: {
1589
1815
  # "TagKey" => "TagValue",
@@ -1622,45 +1848,27 @@ module Aws::LocationService
1622
1848
  # through. Distance-based filtering can also reduce the effects of
1623
1849
  # GPS noise when displaying device trajectories on a map.
1624
1850
  #
1851
+ # * `AccuracyBased` - If the device has moved less than the measured
1852
+ # accuracy, location updates are ignored. For example, if two
1853
+ # consecutive updates from a device have a horizontal accuracy of 5
1854
+ # m and 10 m, the second update is ignored if the device has moved
1855
+ # less than 15 m. Ignored location updates are neither evaluated
1856
+ # against linked geofence collections, nor stored. This can reduce
1857
+ # the effects of GPS noise when displaying device trajectories on a
1858
+ # map, and can help control your costs by reducing the number of
1859
+ # geofence evaluations.
1860
+ #
1625
1861
  # This field is optional. If not specified, the default value is
1626
1862
  # `TimeBased`.
1627
1863
  # @return [String]
1628
1864
  #
1629
1865
  # @!attribute [rw] pricing_plan
1630
- # Specifies the pricing plan for the tracker resource.
1631
- #
1632
- # For additional details and restrictions on each pricing plan option,
1633
- # see [Amazon Location Service pricing][1].
1634
- #
1635
- #
1636
- #
1637
- # [1]: https://aws.amazon.com/location/pricing/
1866
+ # No longer used. If included, the only allowed value is
1867
+ # `RequestBasedUsage`.
1638
1868
  # @return [String]
1639
1869
  #
1640
1870
  # @!attribute [rw] pricing_plan_data_source
1641
- # Specifies the data provider for the tracker resource.
1642
- #
1643
- # * Required value for the following pricing plans:
1644
- # `MobileAssetTracking `\| `MobileAssetManagement`
1645
- #
1646
- # ^
1647
- #
1648
- # For more information about [Data Providers][1], and [Pricing
1649
- # plans][2], see the Amazon Location Service product page.
1650
- #
1651
- # <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to
1652
- # calculate billing for your tracker resource. Your data will not be
1653
- # shared with the data provider, and will remain in your AWS account
1654
- # or Region unless you move it.
1655
- #
1656
- # </note>
1657
- #
1658
- # Valid values: `Esri` \| `Here`
1659
- #
1660
- #
1661
- #
1662
- # [1]: https://aws.amazon.com/location/data-providers/
1663
- # [2]: https://aws.amazon.com/location/pricing/
1871
+ # This parameter is no longer used.
1664
1872
  # @return [String]
1665
1873
  #
1666
1874
  # @!attribute [rw] tags
@@ -1966,18 +2174,11 @@ module Aws::LocationService
1966
2174
  # @return [String]
1967
2175
  #
1968
2176
  # @!attribute [rw] pricing_plan
1969
- # The pricing plan selected for the specified geofence collection.
1970
- #
1971
- # For additional details and restrictions on each pricing plan option,
1972
- # see the [Amazon Location Service pricing page][1].
1973
- #
1974
- #
1975
- #
1976
- # [1]: https://aws.amazon.com/location/pricing/
2177
+ # No longer used. Always returns `RequestBasedUsage`.
1977
2178
  # @return [String]
1978
2179
  #
1979
2180
  # @!attribute [rw] pricing_plan_data_source
1980
- # The specified data provider for the geofence collection.
2181
+ # No longer used. Always returns an empty string.
1981
2182
  # @return [String]
1982
2183
  #
1983
2184
  # @!attribute [rw] tags
@@ -2063,9 +2264,7 @@ module Aws::LocationService
2063
2264
  # @return [String]
2064
2265
  #
2065
2266
  # @!attribute [rw] pricing_plan
2066
- # The pricing plan selected for the specified map resource.
2067
- #
2068
- # <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2267
+ # No longer used. Always returns `RequestBasedUsage`.
2069
2268
  # @return [String]
2070
2269
  #
2071
2270
  # @!attribute [rw] tags
@@ -2164,14 +2363,7 @@ module Aws::LocationService
2164
2363
  # @return [String]
2165
2364
  #
2166
2365
  # @!attribute [rw] pricing_plan
2167
- # The pricing plan selected for the specified place index resource.
2168
- #
2169
- # For additional details and restrictions on each pricing plan option,
2170
- # see [Amazon Location Service pricing][1].
2171
- #
2172
- #
2173
- #
2174
- # [1]: https://aws.amazon.com/location/pricing/
2366
+ # No longer used. Always returns `RequestBasedUsage`.
2175
2367
  # @return [String]
2176
2368
  #
2177
2369
  # @!attribute [rw] tags
@@ -2270,15 +2462,7 @@ module Aws::LocationService
2270
2462
  # @return [String]
2271
2463
  #
2272
2464
  # @!attribute [rw] pricing_plan
2273
- # The pricing plan selected for the specified route calculator
2274
- # resource.
2275
- #
2276
- # For additional details and restrictions on each pricing plan option,
2277
- # see [Amazon Location Service pricing][1].
2278
- #
2279
- #
2280
- #
2281
- # [1]: https://aws.amazon.com/location/pricing/
2465
+ # Always returns `RequestBasedUsage`.
2282
2466
  # @return [String]
2283
2467
  #
2284
2468
  # @!attribute [rw] tags
@@ -2359,18 +2543,11 @@ module Aws::LocationService
2359
2543
  # @return [String]
2360
2544
  #
2361
2545
  # @!attribute [rw] pricing_plan
2362
- # The pricing plan selected for the specified tracker resource.
2363
- #
2364
- # For additional details and restrictions on each pricing plan option,
2365
- # see [Amazon Location Service pricing][1].
2366
- #
2367
- #
2368
- #
2369
- # [1]: https://aws.amazon.com/location/pricing/
2546
+ # Always returns `RequestBasedUsage`.
2370
2547
  # @return [String]
2371
2548
  #
2372
2549
  # @!attribute [rw] pricing_plan_data_source
2373
- # The specified data provider for the tracker resource.
2550
+ # No longer used. Always returns an empty string.
2374
2551
  # @return [String]
2375
2552
  #
2376
2553
  # @!attribute [rw] tags
@@ -2419,6 +2596,10 @@ module Aws::LocationService
2419
2596
 
2420
2597
  # Contains the device position details.
2421
2598
  #
2599
+ # @!attribute [rw] accuracy
2600
+ # The accuracy of the device position.
2601
+ # @return [Types::PositionalAccuracy]
2602
+ #
2422
2603
  # @!attribute [rw] device_id
2423
2604
  # The device whose position you retrieved.
2424
2605
  # @return [String]
@@ -2427,6 +2608,10 @@ module Aws::LocationService
2427
2608
  # The last known device position.
2428
2609
  # @return [Array<Float>]
2429
2610
  #
2611
+ # @!attribute [rw] position_properties
2612
+ # The properties associated with the position.
2613
+ # @return [Hash<String,String>]
2614
+ #
2430
2615
  # @!attribute [rw] received_time
2431
2616
  # The timestamp for when the tracker resource received the device
2432
2617
  # position in [ ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -2448,11 +2633,13 @@ module Aws::LocationService
2448
2633
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePosition AWS API Documentation
2449
2634
  #
2450
2635
  class DevicePosition < Struct.new(
2636
+ :accuracy,
2451
2637
  :device_id,
2452
2638
  :position,
2639
+ :position_properties,
2453
2640
  :received_time,
2454
2641
  :sample_time)
2455
- SENSITIVE = [:position]
2642
+ SENSITIVE = [:position, :position_properties]
2456
2643
  include Aws::Structure
2457
2644
  end
2458
2645
 
@@ -2462,11 +2649,21 @@ module Aws::LocationService
2462
2649
  # data as a hash:
2463
2650
  #
2464
2651
  # {
2652
+ # accuracy: {
2653
+ # horizontal: 1.0, # required
2654
+ # },
2465
2655
  # device_id: "Id", # required
2466
2656
  # position: [1.0], # required
2657
+ # position_properties: {
2658
+ # "PropertyMapKeyString" => "PropertyMapValueString",
2659
+ # },
2467
2660
  # sample_time: Time.now, # required
2468
2661
  # }
2469
2662
  #
2663
+ # @!attribute [rw] accuracy
2664
+ # The accuracy of the device position.
2665
+ # @return [Types::PositionalAccuracy]
2666
+ #
2470
2667
  # @!attribute [rw] device_id
2471
2668
  # The device associated to the position update.
2472
2669
  # @return [String]
@@ -2480,6 +2677,14 @@ module Aws::LocationService
2480
2677
  # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
2481
2678
  # @return [Array<Float>]
2482
2679
  #
2680
+ # @!attribute [rw] position_properties
2681
+ # Associates one of more properties with the position update. A
2682
+ # property is a key-value pair stored with the position update and
2683
+ # added to any geofence event the update may trigger.
2684
+ #
2685
+ # Format: `"key" : "value"`
2686
+ # @return [Hash<String,String>]
2687
+ #
2483
2688
  # @!attribute [rw] sample_time
2484
2689
  # The timestamp at which the device's position was determined. Uses
2485
2690
  # [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
@@ -2492,10 +2697,12 @@ module Aws::LocationService
2492
2697
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePositionUpdate AWS API Documentation
2493
2698
  #
2494
2699
  class DevicePositionUpdate < Struct.new(
2700
+ :accuracy,
2495
2701
  :device_id,
2496
2702
  :position,
2703
+ :position_properties,
2497
2704
  :sample_time)
2498
- SENSITIVE = [:position]
2705
+ SENSITIVE = [:position, :position_properties]
2499
2706
  include Aws::Structure
2500
2707
  end
2501
2708
 
@@ -2696,6 +2903,10 @@ module Aws::LocationService
2696
2903
  include Aws::Structure
2697
2904
  end
2698
2905
 
2906
+ # @!attribute [rw] accuracy
2907
+ # The accuracy of the device position.
2908
+ # @return [Types::PositionalAccuracy]
2909
+ #
2699
2910
  # @!attribute [rw] device_id
2700
2911
  # The device whose position you retrieved.
2701
2912
  # @return [String]
@@ -2704,6 +2915,10 @@ module Aws::LocationService
2704
2915
  # The last known device position.
2705
2916
  # @return [Array<Float>]
2706
2917
  #
2918
+ # @!attribute [rw] position_properties
2919
+ # The properties associated with the position.
2920
+ # @return [Hash<String,String>]
2921
+ #
2707
2922
  # @!attribute [rw] received_time
2708
2923
  # The timestamp for when the tracker resource received the device
2709
2924
  # position in [ ISO 8601 ][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -2725,11 +2940,13 @@ module Aws::LocationService
2725
2940
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionResponse AWS API Documentation
2726
2941
  #
2727
2942
  class GetDevicePositionResponse < Struct.new(
2943
+ :accuracy,
2728
2944
  :device_id,
2729
2945
  :position,
2946
+ :position_properties,
2730
2947
  :received_time,
2731
2948
  :sample_time)
2732
- SENSITIVE = [:position]
2949
+ SENSITIVE = [:position, :position_properties]
2733
2950
  include Aws::Structure
2734
2951
  end
2735
2952
 
@@ -3077,7 +3294,7 @@ module Aws::LocationService
3077
3294
  #
3078
3295
  #
3079
3296
  #
3080
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
3297
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
3081
3298
  #
3082
3299
  # @!attribute [rw] distance
3083
3300
  # The distance between the leg's `StartPosition` and `EndPosition`
@@ -3106,7 +3323,7 @@ module Aws::LocationService
3106
3323
  #
3107
3324
  #
3108
3325
  #
3109
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
3326
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html
3110
3327
  # @return [Array<Float>]
3111
3328
  #
3112
3329
  # @!attribute [rw] geometry
@@ -3124,7 +3341,7 @@ module Aws::LocationService
3124
3341
  #
3125
3342
  #
3126
3343
  #
3127
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
3344
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
3128
3345
  # @return [Array<Float>]
3129
3346
  #
3130
3347
  # @!attribute [rw] steps
@@ -3232,6 +3449,10 @@ module Aws::LocationService
3232
3449
 
3233
3450
  # Contains the tracker resource details.
3234
3451
  #
3452
+ # @!attribute [rw] accuracy
3453
+ # The accuracy of the device position.
3454
+ # @return [Types::PositionalAccuracy]
3455
+ #
3235
3456
  # @!attribute [rw] device_id
3236
3457
  # The ID of the device for this position.
3237
3458
  # @return [String]
@@ -3241,6 +3462,10 @@ module Aws::LocationService
3241
3462
  # stored.
3242
3463
  # @return [Array<Float>]
3243
3464
  #
3465
+ # @!attribute [rw] position_properties
3466
+ # The properties associated with the position.
3467
+ # @return [Hash<String,String>]
3468
+ #
3244
3469
  # @!attribute [rw] sample_time
3245
3470
  # The timestamp at which the device position was determined. Uses [
3246
3471
  # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -3253,10 +3478,12 @@ module Aws::LocationService
3253
3478
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositionsResponseEntry AWS API Documentation
3254
3479
  #
3255
3480
  class ListDevicePositionsResponseEntry < Struct.new(
3481
+ :accuracy,
3256
3482
  :device_id,
3257
3483
  :position,
3484
+ :position_properties,
3258
3485
  :sample_time)
3259
- SENSITIVE = [:position]
3486
+ SENSITIVE = [:position, :position_properties]
3260
3487
  include Aws::Structure
3261
3488
  end
3262
3489
 
@@ -3331,18 +3558,11 @@ module Aws::LocationService
3331
3558
  # @return [String]
3332
3559
  #
3333
3560
  # @!attribute [rw] pricing_plan
3334
- # The pricing plan for the specified geofence collection.
3335
- #
3336
- # For additional details and restrictions on each pricing plan option,
3337
- # see the [Amazon Location Service pricing page][1].
3338
- #
3339
- #
3340
- #
3341
- # [1]: https://aws.amazon.com/location/pricing/
3561
+ # No longer used. Always returns `RequestBasedUsage`.
3342
3562
  # @return [String]
3343
3563
  #
3344
3564
  # @!attribute [rw] pricing_plan_data_source
3345
- # The specified data provider for the geofence collection.
3565
+ # No longer used. Always returns an empty string.
3346
3566
  # @return [String]
3347
3567
  #
3348
3568
  # @!attribute [rw] update_time
@@ -3545,14 +3765,7 @@ module Aws::LocationService
3545
3765
  # @return [String]
3546
3766
  #
3547
3767
  # @!attribute [rw] pricing_plan
3548
- # The pricing plan for the specified map resource.
3549
- #
3550
- # For additional details and restrictions on each pricing plan option,
3551
- # see [Amazon Location Service pricing][1].
3552
- #
3553
- #
3554
- #
3555
- # [1]: https://aws.amazon.com/location/pricing/
3768
+ # No longer used. Always returns `RequestBasedUsage`.
3556
3769
  # @return [String]
3557
3770
  #
3558
3771
  # @!attribute [rw] update_time
@@ -3664,14 +3877,7 @@ module Aws::LocationService
3664
3877
  # @return [String]
3665
3878
  #
3666
3879
  # @!attribute [rw] pricing_plan
3667
- # The pricing plan for the specified place index resource.
3668
- #
3669
- # For additional details and restrictions on each pricing plan option,
3670
- # see [Amazon Location Service pricing][1].
3671
- #
3672
- #
3673
- #
3674
- # [1]: https://aws.amazon.com/location/pricing/
3880
+ # No longer used. Always returns `RequestBasedUsage`.
3675
3881
  # @return [String]
3676
3882
  #
3677
3883
  # @!attribute [rw] update_time
@@ -3786,14 +3992,7 @@ module Aws::LocationService
3786
3992
  # @return [String]
3787
3993
  #
3788
3994
  # @!attribute [rw] pricing_plan
3789
- # The pricing plan for the specified route calculator resource.
3790
- #
3791
- # For additional details and restrictions on each pricing plan option,
3792
- # see [Amazon Location Service pricing][1].
3793
- #
3794
- #
3795
- #
3796
- # [1]: https://aws.amazon.com/location/pricing/
3995
+ # Always returns `RequestBasedUsage`.
3797
3996
  # @return [String]
3798
3997
  #
3799
3998
  # @!attribute [rw] update_time
@@ -3992,18 +4191,11 @@ module Aws::LocationService
3992
4191
  # @return [String]
3993
4192
  #
3994
4193
  # @!attribute [rw] pricing_plan
3995
- # The pricing plan for the specified tracker resource.
3996
- #
3997
- # For additional details and restrictions on each pricing plan option,
3998
- # see [Amazon Location Service pricing][1].
3999
- #
4000
- #
4001
- #
4002
- # [1]: https://aws.amazon.com/location/pricing/
4194
+ # Always returns `RequestBasedUsage`.
4003
4195
  # @return [String]
4004
4196
  #
4005
4197
  # @!attribute [rw] pricing_plan_data_source
4006
- # The specified data provider for the tracker resource.
4198
+ # No longer used. Always returns an empty string.
4007
4199
  # @return [String]
4008
4200
  #
4009
4201
  # @!attribute [rw] tracker_name
@@ -4215,6 +4407,28 @@ module Aws::LocationService
4215
4407
  include Aws::Structure
4216
4408
  end
4217
4409
 
4410
+ # Defines the level of certainty of the position.
4411
+ #
4412
+ # @note When making an API call, you may pass PositionalAccuracy
4413
+ # data as a hash:
4414
+ #
4415
+ # {
4416
+ # horizontal: 1.0, # required
4417
+ # }
4418
+ #
4419
+ # @!attribute [rw] horizontal
4420
+ # Estimated maximum distance, in meters, between the measured position
4421
+ # and the true position of a device, along the Earth's surface.
4422
+ # @return [Float]
4423
+ #
4424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PositionalAccuracy AWS API Documentation
4425
+ #
4426
+ class PositionalAccuracy < Struct.new(
4427
+ :horizontal)
4428
+ SENSITIVE = []
4429
+ include Aws::Structure
4430
+ end
4431
+
4218
4432
  # @note When making an API call, you may pass PutGeofenceRequest
4219
4433
  # data as a hash:
4220
4434
  #
@@ -4306,6 +4520,89 @@ module Aws::LocationService
4306
4520
  include Aws::Structure
4307
4521
  end
4308
4522
 
4523
+ # The result for one `SnappedDeparturePosition`
4524
+ # `SnappedDestinationPosition` pair.
4525
+ #
4526
+ # @!attribute [rw] distance
4527
+ # The total distance of travel for the route.
4528
+ # @return [Float]
4529
+ #
4530
+ # @!attribute [rw] duration_seconds
4531
+ # The expected duration of travel for the route.
4532
+ # @return [Float]
4533
+ #
4534
+ # @!attribute [rw] error
4535
+ # An error corresponding to the calculation of a route between the
4536
+ # `DeparturePosition` and `DestinationPosition`.
4537
+ # @return [Types::RouteMatrixEntryError]
4538
+ #
4539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/RouteMatrixEntry AWS API Documentation
4540
+ #
4541
+ class RouteMatrixEntry < Struct.new(
4542
+ :distance,
4543
+ :duration_seconds,
4544
+ :error)
4545
+ SENSITIVE = []
4546
+ include Aws::Structure
4547
+ end
4548
+
4549
+ # An error corresponding to the calculation of a route between the
4550
+ # `DeparturePosition` and `DestinationPosition`.
4551
+ #
4552
+ # The error code can be one of the following:
4553
+ #
4554
+ # * `RouteNotFound` - Unable to find a valid route with the given
4555
+ # parameters.
4556
+ #
4557
+ # ^
4558
+ # ^
4559
+ #
4560
+ # * `RouteTooLong` - Route calculation went beyond the maximum size of a
4561
+ # route and was terminated before completion.
4562
+ #
4563
+ # ^
4564
+ # ^
4565
+ #
4566
+ # * `PositionsNotFound` - One or more of the input positions were not
4567
+ # found on the route network.
4568
+ #
4569
+ # ^
4570
+ # ^
4571
+ #
4572
+ # * `DestinationPositionNotFound` - The destination position was not
4573
+ # found on the route network.
4574
+ #
4575
+ # ^
4576
+ # ^
4577
+ #
4578
+ # * `DeparturePositionNotFound` - The departure position was not found
4579
+ # on the route network.
4580
+ #
4581
+ # ^
4582
+ # ^
4583
+ #
4584
+ # * `OtherValidationError` - The given inputs were not valid or a route
4585
+ # was not found. More information is given in the error `Message`
4586
+ #
4587
+ # ^
4588
+ #
4589
+ # @!attribute [rw] code
4590
+ # The type of error which occurred for the route calculation.
4591
+ # @return [String]
4592
+ #
4593
+ # @!attribute [rw] message
4594
+ # A message about the error that occurred for the route calculation.
4595
+ # @return [String]
4596
+ #
4597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/RouteMatrixEntryError AWS API Documentation
4598
+ #
4599
+ class RouteMatrixEntryError < Struct.new(
4600
+ :code,
4601
+ :message)
4602
+ SENSITIVE = []
4603
+ include Aws::Structure
4604
+ end
4605
+
4309
4606
  # Contains a search result from a position search query that is run on a
4310
4607
  # place index resource.
4311
4608
  #
@@ -4332,6 +4629,22 @@ module Aws::LocationService
4332
4629
  include Aws::Structure
4333
4630
  end
4334
4631
 
4632
+ # Contains a place suggestion resulting from a place suggestion query
4633
+ # that is run on a place index resource.
4634
+ #
4635
+ # @!attribute [rw] text
4636
+ # The text of the place suggestion, typically formatted as an address
4637
+ # string.
4638
+ # @return [String]
4639
+ #
4640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForSuggestionsResult AWS API Documentation
4641
+ #
4642
+ class SearchForSuggestionsResult < Struct.new(
4643
+ :text)
4644
+ SENSITIVE = []
4645
+ include Aws::Structure
4646
+ end
4647
+
4335
4648
  # Contains a search result from a text search query that is run on a
4336
4649
  # place index resource.
4337
4650
  #
@@ -4496,6 +4809,210 @@ module Aws::LocationService
4496
4809
  include Aws::Structure
4497
4810
  end
4498
4811
 
4812
+ # @note When making an API call, you may pass SearchPlaceIndexForSuggestionsRequest
4813
+ # data as a hash:
4814
+ #
4815
+ # {
4816
+ # bias_position: [1.0],
4817
+ # filter_b_box: [1.0],
4818
+ # filter_countries: ["CountryCode"],
4819
+ # index_name: "ResourceName", # required
4820
+ # language: "LanguageTag",
4821
+ # max_results: 1,
4822
+ # text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
4823
+ # }
4824
+ #
4825
+ # @!attribute [rw] bias_position
4826
+ # An optional parameter that indicates a preference for place
4827
+ # suggestions that are closer to a specified position.
4828
+ #
4829
+ # If provided, this parameter must contain a pair of numbers. The
4830
+ # first number represents the X coordinate, or longitude; the second
4831
+ # number represents the Y coordinate, or latitude.
4832
+ #
4833
+ # For example, `[-123.1174, 49.2847]` represents the position with
4834
+ # longitude `-123.1174` and latitude `49.2847`.
4835
+ #
4836
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
4837
+ # both options results in an error.
4838
+ #
4839
+ # </note>
4840
+ # @return [Array<Float>]
4841
+ #
4842
+ # @!attribute [rw] filter_b_box
4843
+ # An optional parameter that limits the search results by returning
4844
+ # only suggestions within a specified bounding box.
4845
+ #
4846
+ # If provided, this parameter must contain a total of four consecutive
4847
+ # numbers in two pairs. The first pair of numbers represents the X and
4848
+ # Y coordinates (longitude and latitude, respectively) of the
4849
+ # southwest corner of the bounding box; the second pair of numbers
4850
+ # represents the X and Y coordinates (longitude and latitude,
4851
+ # respectively) of the northeast corner of the bounding box.
4852
+ #
4853
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
4854
+ # bounding box where the southwest corner has longitude `-12.7935` and
4855
+ # latitude `-37.4835`, and the northeast corner has longitude
4856
+ # `-12.0684` and latitude `-36.9542`.
4857
+ #
4858
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
4859
+ # both options results in an error.
4860
+ #
4861
+ # </note>
4862
+ # @return [Array<Float>]
4863
+ #
4864
+ # @!attribute [rw] filter_countries
4865
+ # An optional parameter that limits the search results by returning
4866
+ # only suggestions within the provided list of countries.
4867
+ #
4868
+ # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
4869
+ # uses three upper-case characters: `AUS`.
4870
+ #
4871
+ # ^
4872
+ #
4873
+ #
4874
+ #
4875
+ # [1]: https://www.iso.org/iso-3166-country-codes.html
4876
+ # @return [Array<String>]
4877
+ #
4878
+ # @!attribute [rw] index_name
4879
+ # The name of the place index resource you want to use for the search.
4880
+ # @return [String]
4881
+ #
4882
+ # @!attribute [rw] language
4883
+ # The preferred language used to return results. The value must be a
4884
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4885
+ #
4886
+ # This setting affects the languages used in the results. It does not
4887
+ # change which results are returned. If the language is not specified,
4888
+ # or not supported for a particular result, the partner automatically
4889
+ # chooses a language for the result.
4890
+ #
4891
+ # Used only when the partner selected is Here.
4892
+ #
4893
+ #
4894
+ #
4895
+ # [1]: https://tools.ietf.org/search/bcp47
4896
+ # @return [String]
4897
+ #
4898
+ # @!attribute [rw] max_results
4899
+ # An optional parameter. The maximum number of results returned per
4900
+ # request.
4901
+ #
4902
+ # The default: `5`
4903
+ # @return [Integer]
4904
+ #
4905
+ # @!attribute [rw] text
4906
+ # The free-form partial text to use to generate place suggestions. For
4907
+ # example, `eiffel tow`.
4908
+ # @return [String]
4909
+ #
4910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsRequest AWS API Documentation
4911
+ #
4912
+ class SearchPlaceIndexForSuggestionsRequest < Struct.new(
4913
+ :bias_position,
4914
+ :filter_b_box,
4915
+ :filter_countries,
4916
+ :index_name,
4917
+ :language,
4918
+ :max_results,
4919
+ :text)
4920
+ SENSITIVE = [:bias_position, :filter_b_box, :text]
4921
+ include Aws::Structure
4922
+ end
4923
+
4924
+ # @!attribute [rw] results
4925
+ # A list of place suggestions that best match the search text.
4926
+ # @return [Array<Types::SearchForSuggestionsResult>]
4927
+ #
4928
+ # @!attribute [rw] summary
4929
+ # Contains a summary of the request. Echoes the input values for
4930
+ # `BiasPosition`, `FilterBBox`, `FilterCountries`, `Language`,
4931
+ # `MaxResults`, and `Text`. Also includes the `DataSource` of the
4932
+ # place index.
4933
+ # @return [Types::SearchPlaceIndexForSuggestionsSummary]
4934
+ #
4935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsResponse AWS API Documentation
4936
+ #
4937
+ class SearchPlaceIndexForSuggestionsResponse < Struct.new(
4938
+ :results,
4939
+ :summary)
4940
+ SENSITIVE = []
4941
+ include Aws::Structure
4942
+ end
4943
+
4944
+ # A summary of the request sent by using
4945
+ # `SearchPlaceIndexForSuggestions`.
4946
+ #
4947
+ # @!attribute [rw] bias_position
4948
+ # Contains the coordinates for the optional bias position specified in
4949
+ # the request.
4950
+ #
4951
+ # This parameter contains a pair of numbers. The first number
4952
+ # represents the X coordinate, or longitude; the second number
4953
+ # represents the Y coordinate, or latitude.
4954
+ #
4955
+ # For example, `[-123.1174, 49.2847]` represents the position with
4956
+ # longitude `-123.1174` and latitude `49.2847`.
4957
+ # @return [Array<Float>]
4958
+ #
4959
+ # @!attribute [rw] data_source
4960
+ # The geospatial data provider attached to the place index resource
4961
+ # specified in the request. Values can be one of the following:
4962
+ #
4963
+ # * Esri
4964
+ #
4965
+ # * Here
4966
+ #
4967
+ # For more information about data providers, see [Amazon Location
4968
+ # Service data providers][1].
4969
+ #
4970
+ #
4971
+ #
4972
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
4973
+ # @return [String]
4974
+ #
4975
+ # @!attribute [rw] filter_b_box
4976
+ # Contains the coordinates for the optional bounding box specified in
4977
+ # the request.
4978
+ # @return [Array<Float>]
4979
+ #
4980
+ # @!attribute [rw] filter_countries
4981
+ # Contains the optional country filter specified in the request.
4982
+ # @return [Array<String>]
4983
+ #
4984
+ # @!attribute [rw] language
4985
+ # The preferred language used to return results. Matches the language
4986
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4987
+ # example, `en` for English.
4988
+ #
4989
+ #
4990
+ #
4991
+ # [1]: https://tools.ietf.org/search/bcp47
4992
+ # @return [String]
4993
+ #
4994
+ # @!attribute [rw] max_results
4995
+ # Contains the optional result count limit specified in the request.
4996
+ # @return [Integer]
4997
+ #
4998
+ # @!attribute [rw] text
4999
+ # The free-form partial text input specified in the request.
5000
+ # @return [String]
5001
+ #
5002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsSummary AWS API Documentation
5003
+ #
5004
+ class SearchPlaceIndexForSuggestionsSummary < Struct.new(
5005
+ :bias_position,
5006
+ :data_source,
5007
+ :filter_b_box,
5008
+ :filter_countries,
5009
+ :language,
5010
+ :max_results,
5011
+ :text)
5012
+ SENSITIVE = [:bias_position, :filter_b_box, :text]
5013
+ include Aws::Structure
5014
+ end
5015
+
4499
5016
  # @note When making an API call, you may pass SearchPlaceIndexForTextRequest
4500
5017
  # data as a hash:
4501
5018
  #
@@ -4633,6 +5150,13 @@ module Aws::LocationService
4633
5150
  # @!attribute [rw] bias_position
4634
5151
  # Contains the coordinates for the optional bias position specified in
4635
5152
  # the request.
5153
+ #
5154
+ # This parameter contains a pair of numbers. The first number
5155
+ # represents the X coordinate, or longitude; the second number
5156
+ # represents the Y coordinate, or latitude.
5157
+ #
5158
+ # For example, `[-123.1174, 49.2847]` represents the position with
5159
+ # longitude `-123.1174` and latitude `49.2847`.
4636
5160
  # @return [Array<Float>]
4637
5161
  #
4638
5162
  # @!attribute [rw] data_source
@@ -5009,39 +5533,12 @@ module Aws::LocationService
5009
5533
  # @return [String]
5010
5534
  #
5011
5535
  # @!attribute [rw] pricing_plan
5012
- # Updates the pricing plan for the geofence collection.
5013
- #
5014
- # For more information about each pricing plan option restrictions,
5015
- # see [Amazon Location Service pricing][1].
5016
- #
5017
- #
5018
- #
5019
- # [1]: https://aws.amazon.com/location/pricing/
5536
+ # No longer used. If included, the only allowed value is
5537
+ # `RequestBasedUsage`.
5020
5538
  # @return [String]
5021
5539
  #
5022
5540
  # @!attribute [rw] pricing_plan_data_source
5023
- # Updates the data provider for the geofence collection.
5024
- #
5025
- # A required value for the following pricing plans:
5026
- # `MobileAssetTracking`\| `MobileAssetManagement`
5027
- #
5028
- # For more information about [data providers][1] and [pricing
5029
- # plans][2], see the Amazon Location Service product page.
5030
- #
5031
- # <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
5032
- # request.
5033
- #
5034
- # Amazon Location Service uses `PricingPlanDataSource` to calculate
5035
- # billing for your geofence collection. Your data won't be shared
5036
- # with the data provider, and will remain in your AWS account and
5037
- # Region unless you move it.
5038
- #
5039
- # </note>
5040
- #
5041
- #
5042
- #
5043
- # [1]: https://aws.amazon.com/location/data-providers/
5044
- # [2]: https://aws.amazon.com/location/pricing/
5541
+ # This parameter is no longer used.
5045
5542
  # @return [String]
5046
5543
  #
5047
5544
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollectionRequest AWS API Documentation
@@ -5106,14 +5603,8 @@ module Aws::LocationService
5106
5603
  # @return [String]
5107
5604
  #
5108
5605
  # @!attribute [rw] pricing_plan
5109
- # Updates the pricing plan for the map resource.
5110
- #
5111
- # For more information about each pricing plan option restrictions,
5112
- # see [Amazon Location Service pricing][1].
5113
- #
5114
- #
5115
- #
5116
- # [1]: https://aws.amazon.com/location/pricing/
5606
+ # No longer used. If included, the only allowed value is
5607
+ # `RequestBasedUsage`.
5117
5608
  # @return [String]
5118
5609
  #
5119
5610
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMapRequest AWS API Documentation
@@ -5183,14 +5674,8 @@ module Aws::LocationService
5183
5674
  # @return [String]
5184
5675
  #
5185
5676
  # @!attribute [rw] pricing_plan
5186
- # Updates the pricing plan for the place index resource.
5187
- #
5188
- # For more information about each pricing plan option restrictions,
5189
- # see [Amazon Location Service pricing][1].
5190
- #
5191
- #
5192
- #
5193
- # [1]: https://aws.amazon.com/location/pricing/
5677
+ # No longer used. If included, the only allowed value is
5678
+ # `RequestBasedUsage`.
5194
5679
  # @return [String]
5195
5680
  #
5196
5681
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndexRequest AWS API Documentation
@@ -5255,14 +5740,8 @@ module Aws::LocationService
5255
5740
  # @return [String]
5256
5741
  #
5257
5742
  # @!attribute [rw] pricing_plan
5258
- # Updates the pricing plan for the route calculator resource.
5259
- #
5260
- # For more information about each pricing plan option restrictions,
5261
- # see [Amazon Location Service pricing][1].
5262
- #
5263
- #
5264
- #
5265
- # [1]: https://aws.amazon.com/location/pricing/
5743
+ # No longer used. If included, the only allowed value is
5744
+ # `RequestBasedUsage`.
5266
5745
  # @return [String]
5267
5746
  #
5268
5747
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculatorRequest AWS API Documentation
@@ -5337,45 +5816,28 @@ module Aws::LocationService
5337
5816
  # ft), location updates are ignored. Location updates within this
5338
5817
  # distance are neither evaluated against linked geofence
5339
5818
  # collections, nor stored. This helps control costs by reducing the
5340
- # number of geofence evaluations and device positions to retrieve.
5341
- # Distance-based filtering can also reduce the jitter effect when
5342
- # displaying device trajectory on a map.
5819
+ # number of geofence evaluations and historical device positions to
5820
+ # paginate through. Distance-based filtering can also reduce the
5821
+ # effects of GPS noise when displaying device trajectories on a map.
5822
+ #
5823
+ # * `AccuracyBased` - If the device has moved less than the measured
5824
+ # accuracy, location updates are ignored. For example, if two
5825
+ # consecutive updates from a device have a horizontal accuracy of 5
5826
+ # m and 10 m, the second update is ignored if the device has moved
5827
+ # less than 15 m. Ignored location updates are neither evaluated
5828
+ # against linked geofence collections, nor stored. This helps educe
5829
+ # the effects of GPS noise when displaying device trajectories on a
5830
+ # map, and can help control costs by reducing the number of geofence
5831
+ # evaluations.
5343
5832
  # @return [String]
5344
5833
  #
5345
5834
  # @!attribute [rw] pricing_plan
5346
- # Updates the pricing plan for the tracker resource.
5347
- #
5348
- # For more information about each pricing plan option restrictions,
5349
- # see [Amazon Location Service pricing][1].
5350
- #
5351
- #
5352
- #
5353
- # [1]: https://aws.amazon.com/location/pricing/
5835
+ # No longer used. If included, the only allowed value is
5836
+ # `RequestBasedUsage`.
5354
5837
  # @return [String]
5355
5838
  #
5356
5839
  # @!attribute [rw] pricing_plan_data_source
5357
- # Updates the data provider for the tracker resource.
5358
- #
5359
- # A required value for the following pricing plans:
5360
- # `MobileAssetTracking`\| `MobileAssetManagement`
5361
- #
5362
- # For more information about [data providers][1] and [pricing
5363
- # plans][2], see the Amazon Location Service product page
5364
- #
5365
- # <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
5366
- # request.
5367
- #
5368
- # Amazon Location Service uses `PricingPlanDataSource` to calculate
5369
- # billing for your tracker resource. Your data won't be shared with
5370
- # the data provider, and will remain in your AWS account and Region
5371
- # unless you move it.
5372
- #
5373
- # </note>
5374
- #
5375
- #
5376
- #
5377
- # [1]: https://aws.amazon.com/location/data-providers/
5378
- # [2]: https://aws.amazon.com/location/pricing/
5840
+ # This parameter is no longer used.
5379
5841
  # @return [String]
5380
5842
  #
5381
5843
  # @!attribute [rw] tracker_name